SMART Scheduling Links
1.0.0-ballot - STU 1 Ballot International flag

SMART Scheduling Links, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smart-scheduling-links/ and changes regularly. See the Directory of published versions

Resource Profile: Location

Official URL: http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-location Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: SmartSchedulingLocation

Each line of the Location File is a minified JSON object that conveys a physical location where appointments are available.

Example Usage Scenarios

The following are example usage scenarios for the SMART Scheduling Links Location profile:

  • Find locations where appointments are available

Mandatory and Must Support Data Elements

The following data elements must always be present or must be supported if the data is present in the sending system. They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Location Must Have:

  • id
  • identifier
  • name
  • telecom
  • address line, city, state, and postalCode

Each Location Must Support:

  • status
  • description
  • address use and district
  • position

Profile Specific Implementation Guidance:

Each identifier object includes a system and a value

  • If a PractitionerRole or Location is associated with organization-specific identifiers (such as facility numbers, site codes, or store numbers), publishers SHOULD include these. The system should be a URL that identifies the identifier system, preferably a page on the publisher's web site (e.g. {"system": "https://healthsystem.example.com/facility-directory", "value": "FAC-123"})
  • If a Location participates in external registry programs that assign location identifiers, publishers MAY include these identifiers using the appropriate system URL for the registry
  • Additional identifiers: Any number of additioanl identifiers MAY be included. Each should populate system and value as appropriate, following FHIR identifier conventions.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:virtualService 0..* (Complex) Virtual service connection details (R5 element carried via xver extension)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:channelType 0..1 Extension Channel Type
Constraints: ext-1
....... url 1..1 uri "channelType"
...... extension:address[x] 0..1 Extension Extension
Constraints: ext-1
....... Slices for extension Content/Rules for all slices
....... url 1..1 uri "address[x]"
....... value[x] 0..1 url Contact address/number
...... extension:additionalInfo 0..* Extension Address to see alternative connection details
Constraints: ext-1
....... url 1..1 uri "additionalInfo"
...... extension:maxParticipants 0..1 Extension Maximum number of participants supported by the virtual service
Constraints: ext-1
....... url 1..1 uri "maxParticipants"
...... extension:sessionKey 0..1 Extension Session Key required by the virtual service
Constraints: ext-1
....... url 1..1 uri "sessionKey"
...... extension:_datatype 0..1 (Complex) Data type name for Location.virtualService from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: VirtualServiceDetail
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService"
... identifier SΣ 1..* 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.
... name SΣ 1..1 string Name of the location as used by humans
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... telecom S 1..* ContactPoint Contact details of the location
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... address S 1..1 Address Physical location
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 1..1 string Postal code for area
Example General: 9132
... position S 0..1 BackboneElement The absolute geographic location
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:virtualService 0..* (Complex) Virtual service connection details (R5 element carried via xver extension)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService
..... Slices for extension Content/Rules for all slices
...... extension:address[x] 0..1 Extension Extension
....... extension 0..0 Extension
....... Slices for extension Content/Rules for all slices
........ extension:purpose 0..0 Extension
........ extension:name 0..0 Extension
........ extension:telecom 0..0 Extension
........ extension:address 0..0 Extension
........ extension:organization 0..0 Extension
........ extension:period 0..0 Extension
........ extension:_datatype 0..0 Alternative datatype name (for cross version extensions)
....... value[x] 0..1 url Contact address/number
..... value[x] 0..0 Value of extension
... identifier S 1..* Identifier Unique code or number identifying the location to its users
... description S 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... telecom S 1..* ContactPoint Contact details of the location
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
... address S 1..1 Address Physical location
.... line S 1..* string Street name, number, direction & P.O. Box etc.
.... city S 1..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode S 1..1 string Postal code for area
... position S 0..1 BackboneElement The absolute geographic location
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:virtualService 0..* (Complex) Virtual service connection details (R5 element carried via xver extension)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:channelType 0..1 Extension Channel Type
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "channelType"
....... value[x] 0..1 Coding Channel Type
Binding: R5_virtual_service_type_for_R4 (0.0.1-snapshot-2) (example): The purpose for which an extended contact detail should be used.
...... extension:address[x] 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension Content/Rules for all slices
....... url 1..1 uri "address[x]"
....... value[x] 0..1 url Contact address/number
...... extension:additionalInfo 0..* Extension Address to see alternative connection details
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "additionalInfo"
....... value[x] 0..1 url Address to see alternative connection details
...... extension:maxParticipants 0..1 Extension Maximum number of participants supported by the virtual service
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "maxParticipants"
....... value[x] 0..1 positiveInt Maximum number of participants supported by the virtual service
...... extension:sessionKey 0..1 Extension Session Key required by the virtual service
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "sessionKey"
....... value[x] 0..1 string Session Key required by the virtual service
...... extension:_datatype 0..1 (Complex) Data type name for Location.virtualService from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: VirtualServiceDetail
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* 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 SΣ 1..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 SΣ 0..1 string 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.
... telecom S 1..* ContactPoint Contact details of the location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address S 1..1 Address Physical location
.... id 0..1 string 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.
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 SΣ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 1..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
... position S 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 S 1..1 decimal Longitude with WGS84 datum
.... latitude S 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
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... 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
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean The Location is open all day
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Location.extension:virtualService.​extension:channelType.​value[x] Base example Cross-version VS for R5.VirtualServiceType for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
Location.extension:virtualService.​extension:address[x].​extension:purpose.value[x] Base preferred Cross-version VS for R5.ContactEntityType for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.3
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 11 elements
Must-Support: 16 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:virtualService 0..* (Complex) Virtual service connection details (R5 element carried via xver extension)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:channelType 0..1 Extension Channel Type
Constraints: ext-1
....... url 1..1 uri "channelType"
...... extension:address[x] 0..1 Extension Extension
Constraints: ext-1
....... Slices for extension Content/Rules for all slices
....... url 1..1 uri "address[x]"
....... value[x] 0..1 url Contact address/number
...... extension:additionalInfo 0..* Extension Address to see alternative connection details
Constraints: ext-1
....... url 1..1 uri "additionalInfo"
...... extension:maxParticipants 0..1 Extension Maximum number of participants supported by the virtual service
Constraints: ext-1
....... url 1..1 uri "maxParticipants"
...... extension:sessionKey 0..1 Extension Session Key required by the virtual service
Constraints: ext-1
....... url 1..1 uri "sessionKey"
...... extension:_datatype 0..1 (Complex) Data type name for Location.virtualService from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: VirtualServiceDetail
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService"
... identifier SΣ 1..* 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.
... name SΣ 1..1 string Name of the location as used by humans
... description SΣ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... telecom S 1..* ContactPoint Contact details of the location
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... address S 1..1 Address Physical location
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 1..1 string Postal code for area
Example General: 9132
... position S 0..1 BackboneElement The absolute geographic location
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:virtualService 0..* (Complex) Virtual service connection details (R5 element carried via xver extension)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService
..... Slices for extension Content/Rules for all slices
...... extension:address[x] 0..1 Extension Extension
....... extension 0..0 Extension
....... Slices for extension Content/Rules for all slices
........ extension:purpose 0..0 Extension
........ extension:name 0..0 Extension
........ extension:telecom 0..0 Extension
........ extension:address 0..0 Extension
........ extension:organization 0..0 Extension
........ extension:period 0..0 Extension
........ extension:_datatype 0..0 Alternative datatype name (for cross version extensions)
....... value[x] 0..1 url Contact address/number
..... value[x] 0..0 Value of extension
... identifier S 1..* Identifier Unique code or number identifying the location to its users
... description S 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... telecom S 1..* ContactPoint Contact details of the location
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
... address S 1..1 Address Physical location
.... line S 1..* string Street name, number, direction & P.O. Box etc.
.... city S 1..1 string Name of city, town etc.
.... district S 0..1 string District name (aka county)
.... state S 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode S 1..1 string Postal code for area
... position S 0..1 BackboneElement The absolute geographic location
.... longitude S 1..1 decimal Longitude with WGS84 datum
.... latitude S 1..1 decimal Latitude with WGS84 datum

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... id SΣ 1..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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:virtualService 0..* (Complex) Virtual service connection details (R5 element carried via xver extension)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:channelType 0..1 Extension Channel Type
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "channelType"
....... value[x] 0..1 Coding Channel Type
Binding: R5_virtual_service_type_for_R4 (0.0.1-snapshot-2) (example): The purpose for which an extended contact detail should be used.
...... extension:address[x] 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension Content/Rules for all slices
....... url 1..1 uri "address[x]"
....... value[x] 0..1 url Contact address/number
...... extension:additionalInfo 0..* Extension Address to see alternative connection details
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "additionalInfo"
....... value[x] 0..1 url Address to see alternative connection details
...... extension:maxParticipants 0..1 Extension Maximum number of participants supported by the virtual service
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "maxParticipants"
....... value[x] 0..1 positiveInt Maximum number of participants supported by the virtual service
...... extension:sessionKey 0..1 Extension Session Key required by the virtual service
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "sessionKey"
....... value[x] 0..1 string Session Key required by the virtual service
...... extension:_datatype 0..1 (Complex) Data type name for Location.virtualService from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: VirtualServiceDetail
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Location.virtualService"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* 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 SΣ 1..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 SΣ 0..1 string 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.
... telecom S 1..* ContactPoint Contact details of the location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address S 1..1 Address Physical location
.... id 0..1 string 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.
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 SΣ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 1..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
... position S 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 S 1..1 decimal Longitude with WGS84 datum
.... latitude S 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
... hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
.... 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
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean The Location is open all day
.... openingTime 0..1 time Time that the Location opens
.... closingTime 0..1 time Time that the Location closes
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Location.extension:virtualService.​extension:channelType.​value[x] Base example Cross-version VS for R5.VirtualServiceType for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
Location.extension:virtualService.​extension:address[x].​extension:purpose.value[x] Base preferred Cross-version VS for R5.ContactEntityType for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.3
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 11 elements
Must-Support: 16 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron