Name Flags Card. Type Description & Constraints Filter: Bindings Constraints Obligations
Location
0..*
USCoreLocation(5.0.1)
Details and position information for a physical placeThis profile also complies with the profiles US Core Location Profile (6.1.0) and US Core Location Profile (7.0.0)
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
language
0..1
code
Language of the resource contentBinding: CommonLanguages ( preferred ) : A human language.
text
0..1
Narrative
Text summary of the resource, for human interpretationThis profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
use
?! Σ
0..1
code
usual | official | temp | secondary | old (If known)Binding: IdentifierUse ( required ) : Identifies the purpose for this identifier, if known .
type
Σ
0..1
CodeableConcept
Description of identifierBinding: Identifier Type Codes ( extensible ) : A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system
S Σ
0..1
uri
The namespace for the identifier valueRequired Pattern: http://va.gov/identifiers/$Sta3n/44
value
S Σ
0..1
string
The value that is uniqueExample General: 123456
period
Σ
0..1
Period
Time period when id is/was valid for use
assigner
Σ
0..1
Reference (Organization )
Organization that issued id (may be just text)
status
?! S Σ
0..1
code
active | suspended | inactiveBinding: LocationStatus FHIR ( required ) : see mapping VF_LocationStatus
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
S
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 | kindBinding: LocationMode ( required ) : Indicates whether a resource instance represents a specific location or a class of locations.
Slices for type
Σ
0 .. *
CodeableConcept
Type of function performed Slice: Unordered, Open by value:$this Binding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location.
type:va-service
S Σ
0..1
CodeableConcept
Type of function performedBinding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location. Required Pattern: At least the following
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
coding
1..*
Coding
Code defined by a terminology systemFixed Value: (Complex)
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
system
1..1
uri
Identity of the terminology systemFixed Value: http://va.gov/terminology/VistADefinedTerms/44-9
version
0..1
string
Version of the system - if relevant
code
0..1
code
Symbol in syntax defined by the system
display
0..1
string
Representation defined by the system
userSelected
0..1
boolean
If this coding was chosen directly by the user
text
0..1
string
Plain text representation of the concept
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ
0..1
uri
Identity of the terminology system
version
Σ
0..1
string
Version of the system - if relevant
code
S Σ
0..1
code
Symbol in syntax defined by the system
display
Σ
0..1
string
Representation defined by the system
userSelected
Σ
0..1
boolean
If this coding was chosen directly by the user
text
Σ
0..1
string
Plain text representation of the concept
type:va-stop-code
S Σ
0..1
CodeableConcept
Type of function performedBinding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location. Required Pattern: At least the following
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
coding
1..*
Coding
Code defined by a terminology systemFixed Value: (Complex)
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
system
1..1
uri
Identity of the terminology systemFixed Value: http://va.gov/terminology/VistADefinedTerms/44-8
version
0..1
string
Version of the system - if relevant
code
0..1
code
Symbol in syntax defined by the system
display
0..1
string
Representation defined by the system
userSelected
0..1
boolean
If this coding was chosen directly by the user
text
0..1
string
Plain text representation of the concept
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ
0..1
uri
Identity of the terminology system
version
Σ
0..1
string
Version of the system - if relevant
code
S Σ
0..1
code
Symbol in syntax defined by the system
display
Σ
0..1
string
Representation defined by the system
userSelected
Σ
0..1
boolean
If this coding was chosen directly by the user
text
Σ
0..1
string
Plain text representation of the concept
type:va-credit-code
S Σ
0..1
CodeableConcept
Type of function performedBinding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location. Required Pattern: At least the following
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
coding
1..*
Coding
Code defined by a terminology systemFixed Value: (Complex)
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
system
1..1
uri
Identity of the terminology systemFixed Value: http://va.gov/terminology/VistADefinedTerms/44-2503
version
0..1
string
Version of the system - if relevant
code
0..1
code
Symbol in syntax defined by the system
display
0..1
string
Representation defined by the system
userSelected
0..1
boolean
If this coding was chosen directly by the user
text
0..1
string
Plain text representation of the concept
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ
0..1
uri
Identity of the terminology system
version
Σ
0..1
string
Version of the system - if relevant
code
S Σ
0..1
code
Symbol in syntax defined by the system
display
Σ
0..1
string
Representation defined by the system
userSelected
Σ
0..1
boolean
If this coding was chosen directly by the user
text
Σ
0..1
string
Plain text representation of the concept
telecom
S
0..*
ContactPoint
Contact details of the location
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ C
0..1
code
phone | fax | email | pager | url | sms | otherBinding: ContactPointSystem ( required ) : Telecommunications form for contact point. Required Pattern: phone
value
S Σ
0..1
string
The actual contact point details
use
?! S Σ
0..1
code
home | work | temp | old | mobile - purpose of this contact pointBinding: ContactPointUse ( required ) : Use of contact point. Required Pattern: work
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
0..1
Address
Physical location
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
use
?! Σ
0..1
code
home | work | temp | old | billing - purpose of this addressBinding: AddressUse ( required ) : The use of an address. Example General: home
type
S Σ
0..1
code
postal | physical | bothBinding: AddressType ( required ) : The type of an address (physical / postal). Required Pattern: physical
text
Σ
0..1
string
Text representation of the addressExample General: 137 Nowhere Street, Erewhon 9132
line
S Σ
0..*
string
Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address labelExample General: 137 Nowhere Street
city
S Σ
0..1
string
Name of city, town etc.Example General: Erewhon
district
S Σ
0..1
string
District name (aka county)Example General: Madison
state
S Σ
0..1
string
Sub-unit of country (abbreviations ok)Binding: USPS Two Letter Alphabetic Codes ( extensible ) : Two letter USPS alphabetic codes.
postalCode
S Σ
0..1
string
US Zip CodesExample General: 9132
country
S Σ
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 useExample General: {"start":"2010-03-23","end":"2010-07-01"}
physicalType
Σ
0..1
CodeableConcept
Physical form of the locationBinding: LocationType ( example ) : Physical form of the location.
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
text
S Σ
0..1
string
Plain text representation of the concept
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
S Σ
0..1
Reference (US Core Organization Profile(7.0.0) )
Organization responsible for provisioning and upkeep
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
reference
Σ C
0..1
string
Literal reference, Relative, internal or absolute URL
type
Σ
0..1
uri
Type the reference refers to (e.g. "Patient")Binding: ResourceType ( extensible ) : Aa resource (or, for logical models, the URI of the logical model).
identifier
Σ
0..1
Identifier
Logical reference, when literal reference is not known
display
S Σ
0..1
string
Text alternative for the resourceRequired Pattern: Veterans Administration
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 | sunBinding: 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
Documentation for this format
Path Conformance ValueSet / Code URI
Location.language preferred CommonLanguages http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Location.identifier.use required IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Location.identifier.type extensible Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Location.status required LocationStatus http://va.gov/fhir/ValueSet/LocationStatus
From this IG
Location.operationalStatus preferred Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode required LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1
From the FHIR Standard
Location.type extensible ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-service extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-stop-code extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-credit-code extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system required Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Location.telecom.use required Pattern Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Location.address.use required AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Location.address.type required Pattern Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Location.address.state extensible UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalType example LocationType http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard
Location.managingOrganization.type extensible ResourceType http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Location.hoursOfOperation.daysOfWeek required DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard
Constraints
Id Grade Path(s) Details Requirements
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()
This structure is derived from USCoreLocation
Summary
Must-Support: 21 elements
Slices
This structure defines the following Slices :
The element 1 is sliced based on the value of Location.type
Key Elements View
Terminology Bindings
Path Conformance ValueSet / Code URI
Location.identifier.use required IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Location.status required LocationStatus http://va.gov/fhir/ValueSet/LocationStatus
From this IG
Location.type extensible ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-service extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-stop-code extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-credit-code extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system required Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Location.telecom.use required Pattern Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Location.address.use required AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Location.address.type required Pattern Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Location.address.state extensible UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalType example LocationType http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard
Constraints
Id Grade Path(s) Details Requirements
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
This structure is derived from USCoreLocation
Terminology Bindings (Differential)
Path Conformance ValueSet URI
Location.status required LocationStatus http://va.gov/fhir/ValueSet/LocationStatus
From this IG
Snapshot View
Name Flags Card. Type Description & Constraints Filter: Bindings Constraints Obligations
Location
0..*
USCoreLocation(5.0.1)
Details and position information for a physical placeThis profile also complies with the profiles US Core Location Profile (6.1.0) and US Core Location Profile (7.0.0)
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
language
0..1
code
Language of the resource contentBinding: CommonLanguages ( preferred ) : A human language.
text
0..1
Narrative
Text summary of the resource, for human interpretationThis profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
use
?! Σ
0..1
code
usual | official | temp | secondary | old (If known)Binding: IdentifierUse ( required ) : Identifies the purpose for this identifier, if known .
type
Σ
0..1
CodeableConcept
Description of identifierBinding: Identifier Type Codes ( extensible ) : A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system
S Σ
0..1
uri
The namespace for the identifier valueRequired Pattern: http://va.gov/identifiers/$Sta3n/44
value
S Σ
0..1
string
The value that is uniqueExample General: 123456
period
Σ
0..1
Period
Time period when id is/was valid for use
assigner
Σ
0..1
Reference (Organization )
Organization that issued id (may be just text)
status
?! S Σ
0..1
code
active | suspended | inactiveBinding: LocationStatus FHIR ( required ) : see mapping VF_LocationStatus
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
S
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 | kindBinding: LocationMode ( required ) : Indicates whether a resource instance represents a specific location or a class of locations.
Slices for type
Σ
0 .. *
CodeableConcept
Type of function performed Slice: Unordered, Open by value:$this Binding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location.
type:va-service
S Σ
0..1
CodeableConcept
Type of function performedBinding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location. Required Pattern: At least the following
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
coding
1..*
Coding
Code defined by a terminology systemFixed Value: (Complex)
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
system
1..1
uri
Identity of the terminology systemFixed Value: http://va.gov/terminology/VistADefinedTerms/44-9
version
0..1
string
Version of the system - if relevant
code
0..1
code
Symbol in syntax defined by the system
display
0..1
string
Representation defined by the system
userSelected
0..1
boolean
If this coding was chosen directly by the user
text
0..1
string
Plain text representation of the concept
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ
0..1
uri
Identity of the terminology system
version
Σ
0..1
string
Version of the system - if relevant
code
S Σ
0..1
code
Symbol in syntax defined by the system
display
Σ
0..1
string
Representation defined by the system
userSelected
Σ
0..1
boolean
If this coding was chosen directly by the user
text
Σ
0..1
string
Plain text representation of the concept
type:va-stop-code
S Σ
0..1
CodeableConcept
Type of function performedBinding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location. Required Pattern: At least the following
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
coding
1..*
Coding
Code defined by a terminology systemFixed Value: (Complex)
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
system
1..1
uri
Identity of the terminology systemFixed Value: http://va.gov/terminology/VistADefinedTerms/44-8
version
0..1
string
Version of the system - if relevant
code
0..1
code
Symbol in syntax defined by the system
display
0..1
string
Representation defined by the system
userSelected
0..1
boolean
If this coding was chosen directly by the user
text
0..1
string
Plain text representation of the concept
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ
0..1
uri
Identity of the terminology system
version
Σ
0..1
string
Version of the system - if relevant
code
S Σ
0..1
code
Symbol in syntax defined by the system
display
Σ
0..1
string
Representation defined by the system
userSelected
Σ
0..1
boolean
If this coding was chosen directly by the user
text
Σ
0..1
string
Plain text representation of the concept
type:va-credit-code
S Σ
0..1
CodeableConcept
Type of function performedBinding: ServiceDeliveryLocationRoleType ( extensible ) : Indicates the type of function performed at the location. Required Pattern: At least the following
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
coding
1..*
Coding
Code defined by a terminology systemFixed Value: (Complex)
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementations
system
1..1
uri
Identity of the terminology systemFixed Value: http://va.gov/terminology/VistADefinedTerms/44-2503
version
0..1
string
Version of the system - if relevant
code
0..1
code
Symbol in syntax defined by the system
display
0..1
string
Representation defined by the system
userSelected
0..1
boolean
If this coding was chosen directly by the user
text
0..1
string
Plain text representation of the concept
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ
0..1
uri
Identity of the terminology system
version
Σ
0..1
string
Version of the system - if relevant
code
S Σ
0..1
code
Symbol in syntax defined by the system
display
Σ
0..1
string
Representation defined by the system
userSelected
Σ
0..1
boolean
If this coding was chosen directly by the user
text
Σ
0..1
string
Plain text representation of the concept
telecom
S
0..*
ContactPoint
Contact details of the location
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
system
S Σ C
0..1
code
phone | fax | email | pager | url | sms | otherBinding: ContactPointSystem ( required ) : Telecommunications form for contact point. Required Pattern: phone
value
S Σ
0..1
string
The actual contact point details
use
?! S Σ
0..1
code
home | work | temp | old | mobile - purpose of this contact pointBinding: ContactPointUse ( required ) : Use of contact point. Required Pattern: work
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
0..1
Address
Physical location
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
use
?! Σ
0..1
code
home | work | temp | old | billing - purpose of this addressBinding: AddressUse ( required ) : The use of an address. Example General: home
type
S Σ
0..1
code
postal | physical | bothBinding: AddressType ( required ) : The type of an address (physical / postal). Required Pattern: physical
text
Σ
0..1
string
Text representation of the addressExample General: 137 Nowhere Street, Erewhon 9132
line
S Σ
0..*
string
Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address labelExample General: 137 Nowhere Street
city
S Σ
0..1
string
Name of city, town etc.Example General: Erewhon
district
S Σ
0..1
string
District name (aka county)Example General: Madison
state
S Σ
0..1
string
Sub-unit of country (abbreviations ok)Binding: USPS Two Letter Alphabetic Codes ( extensible ) : Two letter USPS alphabetic codes.
postalCode
S Σ
0..1
string
US Zip CodesExample General: 9132
country
S Σ
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 useExample General: {"start":"2010-03-23","end":"2010-07-01"}
physicalType
Σ
0..1
CodeableConcept
Physical form of the locationBinding: LocationType ( example ) : Physical form of the location.
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
coding
Σ
0..*
Coding
Code defined by a terminology system
text
S Σ
0..1
string
Plain text representation of the concept
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
S Σ
0..1
Reference (US Core Organization Profile(7.0.0) )
Organization responsible for provisioning and upkeep
id
0..1
string
Unique id for inter-element referencing
extension
0..*
Extension
Additional content defined by implementationsSlice: Unordered, Open by value:url
reference
Σ C
0..1
string
Literal reference, Relative, internal or absolute URL
type
Σ
0..1
uri
Type the reference refers to (e.g. "Patient")Binding: ResourceType ( extensible ) : Aa resource (or, for logical models, the URI of the logical model).
identifier
Σ
0..1
Identifier
Logical reference, when literal reference is not known
display
S Σ
0..1
string
Text alternative for the resourceRequired Pattern: Veterans Administration
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 | sunBinding: 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
Documentation for this format
Terminology Bindings
Path Conformance ValueSet / Code URI
Location.language preferred CommonLanguages http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Location.identifier.use required IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Location.identifier.type extensible Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Location.status required LocationStatus http://va.gov/fhir/ValueSet/LocationStatus
From this IG
Location.operationalStatus preferred Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode required LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1
From the FHIR Standard
Location.type extensible ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-service extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-stop-code extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:va-credit-code extensible Pattern Value: nullhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.system required Pattern Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Location.telecom.use required Pattern Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Location.address.use required AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Location.address.type required Pattern Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Location.address.state extensible UspsTwoLetterAlphabeticCodes http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalType example LocationType http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard
Location.managingOrganization.type extensible ResourceType http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Location.hoursOfOperation.daysOfWeek required DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard
Constraints
Id Grade Path(s) Details Requirements
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()
This structure is derived from USCoreLocation
Summary
Must-Support: 21 elements
Slices
This structure defines the following Slices :
The element 1 is sliced based on the value of Location.type
Other representations of profile: CSV , Excel , Schematron