Page Status: draft updated 2025-08-08

Ändringslogg

ID Datum Kommentar
1 2025-05-07 Placeholder regler för namn och beskrivning

Location

Informationsmodell_2025-05-07_plats Information domain hvo-location, where this resource is represented as Plats

Page index

General information

The Location resource holds information about a delimited geographical location (point) or area (surface) with a definite position.

Scope and Usage

A HVOLocation can be used for locations of different scales - from a hospital campus to a region. Locations can be chained together using the partOf element. In the catalog, all municipalities in Sweden are related to the counties in which they are found in this manner.

Boundaries and Relationships

A HVOLocation refers to a location from a geographical or physical perspective, not from a organization or business perspective (ie the location of a hospital does not contain any information about the organizational structure of the hospital). Use HVOOrganization and HVOOrganizationalUnit for representing organizations.

Background and Context

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.

Profile

idS Σ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
id0..1string
extensionC0..0Extension
urlS1..1uriFixed Value
id0..1string
extensionC0..*Extension
startS Σ C1..1dateTime
endS Σ C0..1dateTime
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriPattern
valueS Σ1..1stringBinding
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriPattern
valueS Σ1..1stringBinding
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
operationalStatusΣ0..1CodingBinding
nameS Σ0..1string
alias0..*string
descriptionS Σ0..1string
modeΣ0..1codeBinding
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
telecom0..*ContactPoint
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeS Σ1..1codeBindingFixed Value
textΣ0..1string
lineS Σ C1..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ0..1Period
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
longitudeS1..1decimal
latitudeS1..1decimal
altitude0..1decimal
managingOrganizationΣ0..1Reference(Organization)
partOfS0..1Reference(HVOLocation)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
openingTime0..1time
closingTime0..1time
availabilityExceptions0..1string
endpoint0..*Reference(Endpoint)
Location
ShortDetails and position information for a physical place
Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: .Role[classCode=SDLC]
Location.id
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
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
ShortMetadata about the resource
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.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.implicitRules
ShortA set of rules under which this content was created
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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Location.text
ShortText summary of the resource, for human interpretation
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.

Cardinality0..1
TypeNarrative
Aliasnarrative, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Location.contained
ShortContained, inline Resources
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.

Cardinality0..*
TypeResource
Aliasinline 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
  • rim: N/A
Location.extension
ShortAdditional content defined by implementations
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.

Cardinality1..*
TypeExtension
Aliasextensions, 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)

Constraints
  • 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()
Mappings
  • rim: N/A
Location.extension:period
ShortOptional Extensions Element
Definition

Extension for Location to express period of validity.

Cardinality1..1
TypeExtension(Period)
Must SupportTrue
Aliasextensions, 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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • 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()
Mappings
  • rim: N/A
  • rim: n/a
Location.extension:period.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.extension:period.extension
ShortAdditional content defined by implementations
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.

Cardinality0..0
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.extension:period.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Must SupportTrue
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
  • rim: N/A
Location.extension:period.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
TypePeriod
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Location.extension:period.value[x].id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.extension:period.value[x].extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.extension:period.value[x].start
ShortStarting time with inclusive boundary
Definition

The start of the period. The boundary is inclusive.

Cardinality1..1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
Location.extension:period.value[x].end
ShortEnd time with inclusive boundary, if not ongoing
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.

Cardinality0..1
TypedateTime
Must SupportTrue
SummaryTrue
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.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

ConditionsThe cardinality or value of this element may be affected by these constraints: per-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
Location.modifierExtension
ShortExtensions that cannot be ignored
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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: N/A
Location.identifier
ShortUnique code or number identifying the location to its users
Definition

Unique code or number identifying the location to its users.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organization label locations in registries, need to keep track of those.

Slicing

Unordered, Open, by system(Value)

Slice on value based on the type code value

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
  • LocationToHVOPlatsLogical: id
Location.identifier:municipality
ShortIdentifier when Location is a municipality (sv: kommun)
Definition

Unique code or number identifying the location to its users.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organization label locations in registries, need to keep track of those.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
Location.identifier:municipality.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.identifier:municipality.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.identifier:municipality.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Location.identifier:municipality.type
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Location.identifier:municipality.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
dummy.se/identifier/hvo-municipalities-scb
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Location.identifier:municipality.value
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Binding

hvo-municipalities-scb (required)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Location.identifier:municipality.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Location.identifier:municipality.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Location.identifier:county
ShortIdentifier when Location is a county (sv: län)
Definition

Unique code or number identifying the location to its users.

Cardinality0..1
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Organization label locations in registries, need to keep track of those.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: .id
Location.identifier:county.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.identifier:county.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.identifier:county.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Location.identifier:county.type
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
Location.identifier:county.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
dummy.se/identifier/hvo-counties-scb
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Location.identifier:county.value
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
Binding

hvo-counties-scb (required)

Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Location.identifier:county.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Location.identifier:county.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Location.status
Shortactive | suspended | inactive
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.

Cardinality1..1
Typecode
Binding

Indicates whether the location is still in use.

LocationStatus (required)

Must SupportTrue
ModifierTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
  • LocationToHVOPlatsLogical: status
Location.operationalStatus
ShortThe operational status of the location (typically only for a bed/room)
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.

Cardinality0..1
TypeCoding
Binding

The operational status if the location (where typically a bed/room).

v2.0116 (preferred)

SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: n/a
Location.name
ShortName of the location as used by humans
Definition

Name of the location as used by humans. Does not need to be unique.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
  • LocationToHVOPlatsLogical: namn
Location.alias
ShortA list of alternate names that the location is known as, or was known as, in the past
Definition

A list of alternate names that the location is known as, or was known as, in the past.

Cardinality0..*
Typestring
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
Location.description
ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
Definition

Description of the Location, which helps in finding or referencing the place.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Humans need additional information to verify a correct location has been identified.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity[classCode=PLC determinerCode=INSTANCE].desc
  • LocationToHVOPlatsLogical: beskrivning
Location.mode
Shortinstance | kind
Definition

Indicates whether a resource instance represents a specific location or a class of locations.

Cardinality0..1
Typecode
Binding

Indicates whether a resource instance represents a specific location or a class of locations.

LocationMode (required)

SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .playingEntity[classCode=PLC].determinerCode
Location.type
ShortCode for functionality of location.
Definition

Indicates the type of function performed at the location.

Cardinality0..*
TypeCodeableConcept
Binding

Indicates the type of function performed at the location.

hvo-location-functionality (required)

Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .code
  • LocationToHVOPlatsLogical: funktion
Location.type.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.type.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Location.type.coding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.type.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.type.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Location.type.coding.version
ShortVersion of the system - if relevant
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Location.type.coding.code
ShortSymbol in syntax defined by the system
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).

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Location.type.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Location.type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Location.type.text
ShortPlain text representation of the concept
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Location.telecom
ShortContact details of the location
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.

Cardinality0..*
TypeContactPoint
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .telecom
Location.address
ShortPhysical location
Definition

Physical location.

Cardinality0..1
TypeAddress
Must SupportTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .addr
Location.address.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.address.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.address.use
Shorthome | work | temp | old | billing - purpose of this address
Definition

The purpose of this address.

Cardinality0..1
Typecode
Binding

The use of an address.

AddressUse (required)

ModifierTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
home
Mappings
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
Location.address.type
Shortpostal | physical | both
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Cardinality1..1
Typecode
Binding

The type of an address (physical / postal).

AddressType (required)

Must SupportTrue
SummaryTrue
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
physical
ExamplesGeneral
both
Mappings
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
Location.address.text
ShortText representation of the address
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
137 Nowhere Street, Erewhon 9132
Mappings
  • v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
  • rim: ./formatted
  • vcard: address label parameter
Location.address.line
ShortA line in an address, according to Swedish standard SS 637003:2015. For example: Backen Norrgården 1B, Hedesunda, Gävle. This repeating element order: The order in which lines should appear in an address label
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Cardinality1..*
Typestring
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • hvo-address-line-1: A line in an address should have max length of 128 characters
    $this.length() <= 128
ExamplesGeneral
137 Nowhere Street
Mappings
  • v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
  • rim: AD.part[parttype = AL]
  • vcard: street
  • servd: ./StreetAddress (newline delimitted)
  • LocationToHVOPlatsLogical: adressrad
Location.address.city
ShortName of city, town etc.
Definition

The name of the city, town, suburb, village or other community or delivery center.

Cardinality0..1
Typestring
SummaryTrue
AliasMunicpality
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Erewhon
Mappings
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
Location.address.district
ShortDistrict name (aka county)
Definition

The name of the administrative area (county).

Cardinality0..1
Typestring
SummaryTrue
AliasCounty
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
Madison
Mappings
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
Location.address.state
ShortSub-unit of country (abbreviations ok)
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).

Cardinality0..1
Typestring
SummaryTrue
AliasProvince, Territory
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
Location.address.postalCode
ShortPostal code for area
Definition

A postal code designating a region defined by the postal service.

Cardinality0..1
Typestring
SummaryTrue
AliasZip
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
9132
Mappings
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
Location.address.country
ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
Definition

Country - a nation as commonly understood or generally accepted.

Cardinality0..1
Typestring
SummaryTrue
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
Location.address.period
ShortTime period when address was/is in use
Definition

Time period when address was/is in use.

Cardinality0..1
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
{
  "start": "2010-03-23",
  "end": "2010-07-01"
}
Mappings
  • v2: XAD.12 / XAD.13 + XAD.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
Location.physicalType
ShortPhysical form of the location
Definition

Physical form of the location, e.g. building, room, vehicle, road.

Cardinality0..1
TypeCodeableConcept
Binding

Physical form of the location.

LocationType (required)

Must SupportTrue
SummaryTrue
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: .playingEntity [classCode=PLC].code
  • LocationToHVOPlatsLogical: typ
Location.physicalType.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.physicalType.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.physicalType.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality1..1
TypeCoding
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Location.physicalType.coding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.physicalType.coding.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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)

Extensions are always sliced by (at least) url

Constraints
  • 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()
Mappings
  • rim: n/a
Location.physicalType.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Location.physicalType.coding.version
ShortVersion of the system - if relevant
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Location.physicalType.coding.code
ShortSymbol in syntax defined by the system
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).

Cardinality1..1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Location.physicalType.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Location.physicalType.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Location.physicalType.text
ShortPlain text representation of the concept
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.

Cardinality0..1
Typestring
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Location.position
ShortThe absolute geographic location
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Cardinality0..1
TypeBackboneElement
Must SupportTrue
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
  • LocationToHVOPlatsLogical: harPosition(HVOPositionLogical)
Location.position.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.position.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: n/a
Location.position.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: N/A
Location.position.longitude
ShortLongitude with WGS84 datum
Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Cardinality1..1
Typedecimal
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.position.latitude
ShortLatitude with WGS84 datum
Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

Cardinality1..1
Typedecimal
Must SupportTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.position.altitude
ShortAltitude with WGS84 datum
Definition

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

Cardinality0..1
Typedecimal
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.managingOrganization
ShortOrganization responsible for provisioning and upkeep
Definition

The organization responsible for the provisioning and upkeep of the location.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scopingEntity[classCode=ORG determinerKind=INSTANCE]
Location.partOf
ShortAnother Location this one is physically a part of
Definition

Another Location of which this Location is physically a part of.

Cardinality0..1
TypeReference(HVOLocation)
Must SupportTrue
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundLink[typeCode=PART].source[classCode=SDLC]
  • LocationToHVOPlatsLogical: delAv(HVOPlatsLogical)
Location.hoursOfOperation
ShortWhat days/times during a week is this location usually open
Definition

What days/times during a week is this location usually open.

Cardinality0..*
TypeBackboneElement
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Location.hoursOfOperation.extension
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: n/a
Location.hoursOfOperation.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Constraints
  • 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()
Mappings
  • rim: N/A
Location.hoursOfOperation.daysOfWeek
Shortmon | tue | wed | thu | fri | sat | sun
Definition

Indicates which days of the week are available between the start and end Times.

Cardinality0..*
Typecode
Binding

The days of the week.

DaysOfWeek (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.allDay
ShortThe Location is open all day
Definition

The Location is open all day.

Cardinality0..1
Typeboolean
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.openingTime
ShortTime that the Location opens
Definition

Time that the Location opens.

Cardinality0..1
Typetime
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.hoursOfOperation.closingTime
ShortTime that the Location closes
Definition

Time that the Location closes.

Cardinality0..1
Typetime
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
Location.availabilityExceptions
ShortDescription of availability exceptions
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.

Cardinality0..1
Typestring
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Location.endpoint
ShortTechnical endpoints providing access to services operated for the location
Definition

Technical endpoints providing access to services operated for the location.

Cardinality0..*
TypeReference(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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
<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" />
<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" />
<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" />
<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" />
<type value="value" />
<path value="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" />
<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" />
<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" />
<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" />
<strength value="required" />
<valueSet value="http://hl7.org/fhir/ValueSet/location-status" />
</binding>
<identity value="LocationToHVOPlatsLogical" />
<map value="status" />
</mapping>
</element>
<element id="Location.name">
<path value="Location.name" />
<mustSupport value="true" />
<identity value="LocationToHVOPlatsLogical" />
<map value="namn" />
</mapping>
</element>
<element id="Location.description">
<path value="Location.description" />
<mustSupport value="true" />
<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" />
<strength value="required" />
<valueSet value="http://electronichealth.se/hvo/ValueSet/hvo-location-functionality" />
</binding>
<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" />
<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" />
<identity value="LocationToHVOPlatsLogical" />
<map value="adressrad" />
</mapping>
</element>
<element id="Location.physicalType">
<path value="Location.physicalType" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="http://hl7.org/fhir/ValueSet/location-physical-type" />
</binding>
<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" />
<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" />
<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" />
<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",
"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": {
{
"type": "value",
"path": "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,
{
"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",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOLocation"
],
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
}
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "LocationToHVOPlatsLogical",
"map": "delAv(HVOPlatsLogical)"
}
]
}
]
}
}

Details

The must-support flag indicates that the element is expected in some use cases, and a missing flag that the element is never used.

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. See Examples of locations for response bodies for different kind of locations
Insert (POST) yes/no
Update (PUT) yes/no
Delete (DEL) no
Operation (GET, POST) yes/no

Query operations

Supported Queries

  1. GET .../Location returns a Bundle of all Locations.
  2. GET .../Location/[LogicalId] returns the Location with the supplied logical ID.
  3. 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.