Vital Records Common Library (VRCL) FHIR Implementation Guide
2.0.0 - STU2 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 2025-03-27 Computable Name: LocationVitalRecords

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation This is an abstract profile.
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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
from this IG
Location.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
from this IG

 

Other representations of profile: CSV, Excel, Schematron