AddCommunication Implementation Guide
2.2 - version 2.2

This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Location

Official URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/CommunicationLocation Version: 2.2
Draft as of 2025-02-04 Computable Name: CommunicationLocation

Profile to hold information about location/address

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... address 0..1 Address Address
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line Σ 1..3 string Line
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string City
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... postalCode Σ 1..1 string Postal Code
ele-1: All FHIR elements must have a @value or children
Example General: 9132
.... country Σ 0..1 string Country
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|5.0.0
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique code or number identifying the location to its users
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ 0..1 string Name of the location as used by humans
... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description Σ 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... contact 0..* ExtendedContactDetail Official contact details for the location
... address 0..1 Address Address
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 1..3 string Line
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string City
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 1..1 string Postal Code
Example General: 9132
.... country Σ 0..1 string Country
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... form Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationForm (example): Physical form of the location.

... position 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(Location) Another Location this one is physically a part of
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... hoursOfOperation 0..* Availability What days/times during a week is this location usually open (including exceptions)
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|5.0.0
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|5.0.0
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard
Location.formexampleLocationForm
http://hl7.org/fhir/ValueSet/location-form
from the FHIR Standard
Location.characteristicexampleLocationCharacteristic
http://hl7.org/fhir/ValueSet/location-characteristic
from the FHIR Standard

This structure is derived from Location

Summary

Mandatory: 0 element(3 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... address 0..1 Address Address
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line Σ 1..3 string Line
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string City
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... postalCode Σ 1..1 string Postal Code
ele-1: All FHIR elements must have a @value or children
Example General: 9132
.... country Σ 0..1 string Country
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|5.0.0
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard

Differential View

This structure is derived from Location

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* Location Details and position information for a place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique code or number identifying the location to its users
... status ?!Σ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ 0..1 string Name of the location as used by humans
... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description Σ 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... contact 0..* ExtendedContactDetail Official contact details for the location
... address 0..1 Address Address
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 1..3 string Line
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 1..1 string City
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 1..1 string Postal Code
Example General: 9132
.... country Σ 0..1 string Country
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... form Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationForm (example): Physical form of the location.

... position 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(Location) Another Location this one is physically a part of
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... hoursOfOperation 0..* Availability What days/times during a week is this location usually open (including exceptions)
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|5.0.0
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|5.0.0
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard
Location.formexampleLocationForm
http://hl7.org/fhir/ValueSet/location-form
from the FHIR Standard
Location.characteristicexampleLocationCharacteristic
http://hl7.org/fhir/ValueSet/location-characteristic
from the FHIR Standard

This structure is derived from Location

Summary

Mandatory: 0 element(3 nested mandatory elements)

 

Other representations of profile: CSV, Excel, Schematron