Vital Records Common Library (VRCL) FHIR Implementation Guide
2.0.0 - STU2-CI Build United States of America flag

Vital Records Common Library (VRCL) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions

Resource Profile: Location for Vital Records ( Abstract )

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Location-vr Version: 2.0.0
Active as of 2026-10-16 Computable Name: LocationVitalRecords

Vital Records Location – defines (but does not require) the standard address extensions for vital records.

Usages:

  • This Profile is not used by any profiles in this Specification

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: doco
Location 0..* USCoreLocation This is an abstract profile.
Details and position information for a physical place
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name This element must be supported. This element is included in summaries. 1..1 string Name of Location
Location.type This element is included in summaries. 0..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 0..1 Address Address
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.line This element must be supported. This element is included in summaries. 0..* string Address text
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Address city
Example General: Erewhon
Location.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.city.Slices for extension.extension:cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Location.address.district This element is included in summaries. 0..1 string Address county
Example General: Madison
Location.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Location.address.state This element must be supported. This element is included in summaries. 0..1 string State/Jurisdiction. Use value in Jurisdiction if present.
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Address zip
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string Address country
Binding: Value Set - Residence Country Vital Records (required)
Location.position 0..1 BackboneElement Geoposition lat/long
Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.position.longitude 1..1 decimal Longitude with WGS84 datum
Location.position.latitude 1..1 decimal Latitude with WGS84 datum
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.4
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocation This is an abstract profile.
Details and position information for a physical place
Location.name 1..1 string Name of Location
Location.type 0..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Location.address 0..1 Address Address
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Location.address.line 0..* string Address text
Location.address.city 0..1 string Address city
Location.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.city.Slices for extension.extension:cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Location.address.district 0..1 string Address county
Location.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Location.address.state 0..1 string State/Jurisdiction. Use value in Jurisdiction if present.
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Location.address.postalCode 0..1 string Address zip
Location.address.country 0..1 string Address country
Binding: Value Set - Residence Country Vital Records (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocation This is an abstract profile.
Details and position information for a physical place
Location.id This element is included in summaries. 0..1 id Logical id of this artifact
Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Location.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
Location.contained 0..* Resource Contained, inline Resources
Location.extension 0..* Extension Additional content defined by implementations
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.identifier This element is included in summaries. 0..* Identifier Unique code or number identifying the location to its users
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus This element is included in summaries. 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).
Location.name This element must be supported. This element is included in summaries. 1..1 string Name of Location
Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode This element is included in summaries. 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type This element is included in summaries. 0..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 0..1 Address Address
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element must be supported. This element is included in summaries. 0..* string Address text
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Address city
Example General: Erewhon
Location.address.city.id 0..1 string xml:id (or equivalent in JSON)
Location.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.city.Slices for extension.extension:cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Location.address.city.value 0..1 string Primitive value for string
Max Length:1048576
Location.address.district This element is included in summaries. 0..1 string Address county
Example General: Madison
Location.address.district.id 0..1 string xml:id (or equivalent in JSON)
Location.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Location.address.district.value 0..1 string Primitive value for string
Max Length:1048576
Location.address.state This element must be supported. This element is included in summaries. 0..1 string State/Jurisdiction. Use value in Jurisdiction if present.
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.id 0..1 string xml:id (or equivalent in JSON)
Location.address.state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Location.address.state.value 0..1 string Primitive value for string
Max Length:1048576
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Address zip
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string Address country
Binding: Value Set - Residence Country Vital Records (required)
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
Location.position 0..1 BackboneElement Geoposition lat/long
Location.position.id 0..1 string Unique id for inter-element referencing
Location.position.extension 0..* Extension Additional content defined by implementations
Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.position.longitude 1..1 decimal Longitude with WGS84 datum
Location.position.latitude 1..1 decimal Latitude with WGS84 datum
Location.position.altitude 0..1 decimal Altitude with WGS84 datum
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(Location) Another Location this one is physically a part of
Location.hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
Location.hoursOfOperation.id 0..1 string Unique id for inter-element referencing
Location.hoursOfOperation.extension 0..* Extension Additional content defined by implementations
Location.hoursOfOperation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay 0..1 boolean The Location is open all day
Location.hoursOfOperation.openingTime 0..1 time Time that the Location opens
Location.hoursOfOperation.closingTime 0..1 time Time that the Location closes
Location.availabilityExceptions 0..1 string Description of availability exceptions
Location.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.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.4
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.4
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocation This is an abstract profile.
Details and position information for a physical place
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name This element must be supported. This element is included in summaries. 1..1 string Name of Location
Location.type This element is included in summaries. 0..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 0..1 Address Address
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.line This element must be supported. This element is included in summaries. 0..* string Address text
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Address city
Example General: Erewhon
Location.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.city.Slices for extension.extension:cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Location.address.district This element is included in summaries. 0..1 string Address county
Example General: Madison
Location.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Location.address.state This element must be supported. This element is included in summaries. 0..1 string State/Jurisdiction. Use value in Jurisdiction if present.
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Address zip
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string Address country
Binding: Value Set - Residence Country Vital Records (required)
Location.position 0..1 BackboneElement Geoposition lat/long
Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.position.longitude 1..1 decimal Longitude with WGS84 datum
Location.position.latitude 1..1 decimal Latitude with WGS84 datum
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.4
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocation This is an abstract profile.
Details and position information for a physical place
Location.name 1..1 string Name of Location
Location.type 0..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Location.address 0..1 Address Address
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Location.address.line 0..* string Address text
Location.address.city 0..1 string Address city
Location.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.city.Slices for extension.extension:cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Location.address.district 0..1 string Address county
Location.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Location.address.state 0..1 string State/Jurisdiction. Use value in Jurisdiction if present.
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Location.address.postalCode 0..1 string Address zip
Location.address.country 0..1 string Address country
Binding: Value Set - Residence Country Vital Records (required)
Location.position 0..1 BackboneElement Geoposition lat/long

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocation This is an abstract profile.
Details and position information for a physical place
Location.id This element is included in summaries. 0..1 id Logical id of this artifact
Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Location.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
Location.contained 0..* Resource Contained, inline Resources
Location.extension 0..* Extension Additional content defined by implementations
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.identifier This element is included in summaries. 0..* Identifier Unique code or number identifying the location to its users
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus This element is included in summaries. 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).
Location.name This element must be supported. This element is included in summaries. 1..1 string Name of Location
Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode This element is included in summaries. 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type This element is included in summaries. 0..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 0..1 Address Address
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element must be supported. This element is included in summaries. 0..* string Address text
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Address city
Example General: Erewhon
Location.address.city.id 0..1 string xml:id (or equivalent in JSON)
Location.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.city.Slices for extension.extension:cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Location.address.city.value 0..1 string Primitive value for string
Max Length:1048576
Location.address.district This element is included in summaries. 0..1 string Address county
Example General: Madison
Location.address.district.id 0..1 string xml:id (or equivalent in JSON)
Location.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Location.address.district.value 0..1 string Primitive value for string
Max Length:1048576
Location.address.state This element must be supported. This element is included in summaries. 0..1 string State/Jurisdiction. Use value in Jurisdiction if present.
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.id 0..1 string xml:id (or equivalent in JSON)
Location.address.state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.address.state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Location.address.state.value 0..1 string Primitive value for string
Max Length:1048576
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Address zip
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string Address country
Binding: Value Set - Residence Country Vital Records (required)
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
Location.position 0..1 BackboneElement Geoposition lat/long
Location.position.id 0..1 string Unique id for inter-element referencing
Location.position.extension 0..* Extension Additional content defined by implementations
Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.position.longitude 1..1 decimal Longitude with WGS84 datum
Location.position.latitude 1..1 decimal Latitude with WGS84 datum
Location.position.altitude 0..1 decimal Altitude with WGS84 datum
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(Location) Another Location this one is physically a part of
Location.hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
Location.hoursOfOperation.id 0..1 string Unique id for inter-element referencing
Location.hoursOfOperation.extension 0..* Extension Additional content defined by implementations
Location.hoursOfOperation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay 0..1 boolean The Location is open all day
Location.hoursOfOperation.openingTime 0..1 time Time that the Location opens
Location.hoursOfOperation.closingTime 0..1 time Time that the Location closes
Location.availabilityExceptions 0..1 string Description of availability exceptions
Location.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.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.4
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.4
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
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

 

Other representations of profile: CSV, Excel, Schematron