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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Location for Vital Records ( Abstract )

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

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	This is an abstractprofile. Details and position information for a physical place dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. ele-1: All FHIR elements must have a @value or children
name	SΣ	1..1	string	Name of Location ele-1: All FHIR elements must have a @value or children
type	Σ	0..*	CodeableConcept	Type is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contact details of the location ele-1: All FHIR elements must have a @value or children
address	S	0..1	Address	Address ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Address text ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Address city ele-1: All FHIR elements must have a @value or children Example General: Erewhon
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
district	Σ	0..1	string	Address county ele-1: All FHIR elements must have a @value or children Example General: Madison
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
state	SΣ	0..1	string	State/Jurisdiction. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
postalCode	SΣ	0..1	string	Address zip ele-1: All FHIR elements must have a @value or children Example General: 9132
country	Σ	0..1	string	Address country Binding: Value Set - Residence Country Vital Records (required) ele-1: All FHIR elements must have a @value or children
position		0..1	BackboneElement	Geoposition lat/long ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
longitude		1..1	decimal	Longitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
latitude		1..1	decimal	Latitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.type	extensible	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG
Location.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG

This structure is derived from USCoreLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	This is an abstractprofile. Details and position information for a physical place
name		1..1	string	Name of Location
type		0..*	CodeableConcept	Type is used to differentiate profiles of this abstract profile
address		0..1	Address	Address
Slices for extension				Content/Rules for all slices
extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
line		0..*	string	Address text
city		0..1	string	Address city
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
district		0..1	string	Address county
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
state		0..1	string	State/Jurisdiction. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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)
postalCode		0..1	string	Address zip
country		0..1	string	Address country Binding: Value Set - Residence Country Vital Records (required)
position		0..1	BackboneElement	Geoposition lat/long
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG
Location.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	This is an abstractprofile. Details and position information for a physical place
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!SΣ	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 Location
alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	Σ	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 is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..1	Address	Address
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
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Σ	0..*	string	Address text This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Address city Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	Address county Example General: Madison
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
value		0..1	string	Primitive value for string Max Length:1048576
state	SΣ	0..1	string	State/Jurisdiction. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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)
value		0..1	string	Primitive value for string Max Length:1048576
postalCode	SΣ	0..1	string	Address zip Example General: 9132
country	Σ	0..1	string	Address country Binding: Value Set - Residence Country Vital Records (required)
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		0..1	BackboneElement	Geoposition lat/long
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)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
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.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Location.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG
Location.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG
Location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from USCoreLocation

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	This is an abstractprofile. Details and position information for a physical place dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!SΣ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. ele-1: All FHIR elements must have a @value or children
name	SΣ	1..1	string	Name of Location ele-1: All FHIR elements must have a @value or children
type	Σ	0..*	CodeableConcept	Type is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contact details of the location ele-1: All FHIR elements must have a @value or children
address	S	0..1	Address	Address ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Address text ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Address city ele-1: All FHIR elements must have a @value or children Example General: Erewhon
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
district	Σ	0..1	string	Address county ele-1: All FHIR elements must have a @value or children Example General: Madison
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
state	SΣ	0..1	string	State/Jurisdiction. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
postalCode	SΣ	0..1	string	Address zip ele-1: All FHIR elements must have a @value or children Example General: 9132
country	Σ	0..1	string	Address country Binding: Value Set - Residence Country Vital Records (required) ele-1: All FHIR elements must have a @value or children
position		0..1	BackboneElement	Geoposition lat/long ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
longitude		1..1	decimal	Longitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
latitude		1..1	decimal	Latitude with WGS84 datum ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(US Core Organization Profile)	Organization responsible for provisioning and upkeep ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
Location.type	extensible	ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG
Location.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG

Differential View

This structure is derived from USCoreLocation

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	This is an abstractprofile. Details and position information for a physical place
name		1..1	string	Name of Location
type		0..*	CodeableConcept	Type is used to differentiate profiles of this abstract profile
address		0..1	Address	Address
Slices for extension				Content/Rules for all slices
extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
line		0..*	string	Address text
city		0..1	string	Address city
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
district		0..1	string	Address county
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
state		0..1	string	State/Jurisdiction. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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)
postalCode		0..1	string	Address zip
country		0..1	string	Address country Binding: Value Set - Residence Country Vital Records (required)
position		0..1	BackboneElement	Geoposition lat/long
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG
Location.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	USCoreLocation	This is an abstractprofile. Details and position information for a physical place
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Unique code or number identifying the location to its users
status	?!SΣ	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 Location
alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
description	Σ	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 is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
telecom	S	0..*	ContactPoint	Contact details of the location
address	S	0..1	Address	Address
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
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Σ	0..*	string	Address text This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Address city Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	Address county Example General: Madison
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
value		0..1	string	Primitive value for string Max Length:1048576
state	SΣ	0..1	string	State/Jurisdiction. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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)
value		0..1	string	Primitive value for string Max Length:1048576
postalCode	SΣ	0..1	string	Address zip Example General: 9132
country	Σ	0..1	string	Address country Binding: Value Set - Residence Country Vital Records (required)
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		0..1	BackboneElement	Geoposition lat/long
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)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Location.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard
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.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Location.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Location.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr from this IG
Location.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG
Location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from USCoreLocation

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr

Other representations of profile: CSV, Excel, Schematron