Birth And Fetal Death (BFDR) FHIR Implementation Guide
2.0.0 - STU2 - CIBuild United States of America flag

Birth And Fetal Death (BFDR) 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/fhir-bfdr/ and changes regularly. See the Directory of published versions

Resource Profile: Birth and Fetal Death Location

Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Location-bfdr Version: 2.0.0
Standards status: Draft Computable Name: LocationBFDR
Other Identifiers: OID:2.16.840.1.113883.4.642.40.13.42.32

Location used for source/destination of transfers and location of birth. Includes all standard extensions

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 12 Facility ID (NPI) - if available FNPI identifier:NPI, type:BFDR = "birth" string
Natality 13 Facility ID (State-Assigned) SFN identifier.extension[JFI], type:BFDR = "birth" Identifier
Natality 253 Name of Facility of Birth HOSP name, type:BFDR = "birth" string
Natality 302 Facility Mother Moved From (if transferred) HOSPFROM name, type:BFDR = "transfer-from" string
Natality 303 Facility Infant Transferred To (if transferred w/in 24 hours) HOSPTO name, type:BFDR = "transfer-to" string

Fetal Death
Use Case # Description IJE Name Field Type Value Set/Comments
Fetal Death 12 Facility ID (NPI) - If available FNPI identifier:NPI, type:BFDR = "birth" string
Fetal Death 13 Facility ID (State-Assigned) SFN identifier.extension[JFI], type:BFDR = "birth" Identifier
Fetal Death 224 Name of Delivery Facility HOSP_D name string
Fetal Death 225 Place of Delivery Street number STNUM_D address.extension[stnum] string
Fetal Death 226 Place of Delivery Pre Directional PREDIR_D address.extension[predir] string
Fetal Death 227 Place of Delivery Street name STNAME_D address.extension[stname] string
Fetal Death 228 Place of Delivery Street designator STDESIG_D address.extension[stdesig] string
Fetal Death 229 Place of Delivery Post Directional POSTDIR_D address.extension[postdir] string
Fetal Death 230 Place of Delivery Unit or Apartment Number APTNUMB_D address.extension[unitnum] string
Fetal Death 231 Place of Delivery Street Address ADDRESS_D address.line string
Fetal Death 232 Place of Delivery Zip code and Zip+4 ZIPCODE_D address.postalCode string
Fetal Death 233 Place of Delivery County (literal) CNTY_D address.district string
Fetal Death 234 Place of Delivery City/Town/Place (literal) CITY_D address.city string
Fetal Death 235 State, U.S. Territory or Canadian Province of Place of Delivery - literal STATE_D address.state (expanded from 2 letter code) string See StateLiterals
Fetal Death 236 Place of Delivery Country (literal) COUNTRY_D address.country (expanded from 2 letter code) string See CountryLiterals
Fetal Death 339 Facility Mother Moved From (if transferred) HOSPFROM name, type:BFDR = "transfer-from" string

Form Mapping

Form Mapping
Item # Form Field FHIR Profile Field Reference
5 Facility Name / Address name/address Certificate of Live Birth
17 Facility Id. identifier:NPI Certificate of Live Birth
28.1 Name of facility mother transferred from: name Certificate of Live Birth
56.1 name of facility infant transferred to: name Certificate of Live Birth
1 Facility name / address name/address Facility Worksheet for the Live Birth Certificate
2 Facility I.D. identifier Facility Worksheet for the Live Birth Certificate
23.1 Name of facility mother transferred from: name Facility Worksheet for the Live Birth Certificate
38.1 name of facility infant transferred to: name Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
8 Facility Name / address name/address Report of Fetal Death
9 Facility Id identifier:NPI Report of Fetal Death
1 Facility name name Facility Worksheet for the Report of Fetal Death
1 Facility address address Facility Worksheet for the Report of Fetal Death
2 Facility I.D. (National Provider Identifier) identifier:NPI Facility Worksheet for the Report of Fetal Death

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* LocationVitalRecords 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.Slices for identifier This element is included in summaries. 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension.extension:JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Location.Slices for identifier.identifier:All Slices.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Location.Slices for identifier.identifier:All Slices.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:NPI This element is included in summaries. 0..1 Identifier Facility NPI Number

Required Pattern:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
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 Facility
Location.Slices for type This element is included in summaries. 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.Slices for type.type:BFDR This element is included in summaries. 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
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 of Location
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string Unit Number
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 Street Address
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 City
Example General: Erewhon
Location.address.city.Slices for extension Content/Rules for all slices
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 County
Example General: Madison
Location.address.district.Slices for extension Content/Rules for all slices
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
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.Slices for extension Content/Rules for all slices
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 Postal Code
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string Country
Binding: Value Set - Residence Country Vital Records (required)
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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
Location.type:BFDR Base required Location Types 📦2.0.0 This IG
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 Vital Records Common Library v2.0
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0

Constraints

Id Grade Path(s) Description Expression

This structure is derived from LocationVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* LocationVitalRecords Details and position information for a physical place
Location.Slices for identifier 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension.extension:JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
Location.Slices for identifier.identifier:All Slices.system 1..1 uri The namespace for the identifier value
Location.Slices for identifier.identifier:All Slices.value 1..1 string The value that is unique
Location.Slices for identifier.identifier:NPI 0..1 Identifier Facility NPI Number
Required Pattern:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Location.name 1..1 string Name of Facility
Location.Slices for type 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
Location.Slices for type.type:BFDR 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 ExtensionPreDirectionalVitalRecords Predirectional
Location.address.Slices for extension.extension:stnum 0..1 ExtensionStreetNumberVitalRecords Street Number
Location.address.Slices for extension.extension:stname 0..1 ExtensionStreetNameVitalRecords Street Name
Location.address.Slices for extension.extension:stdesig 0..1 ExtensionStreetDesignatorVitalRecords Street Designator
Location.address.Slices for extension.extension:postdir 0..1 ExtensionPostDirectionalVitalRecords Postdirectional
Location.address.Slices for extension.extension:unitnumber 0..1 ExtensionUnitOrAptNumberVitalRecords Unit Number
Location.address.line 0..* string Street Address
Location.address.city 0..1 string City
Location.address.district 0..1 string County
Location.address.state 0..1 string State
Location.address.postalCode 0..1 string Postal Code
Location.address.country 0..1 string Country

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.type:BFDR Base required Location Types 📦2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* LocationVitalRecords 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.Slices for identifier This element is included in summaries. 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:All Slices.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:All Slices.Slices for extension.extension:JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Location.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Location.Slices for identifier.identifier:All Slices.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Location.Slices for identifier.identifier:All Slices.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:NPI This element is included in summaries. 0..1 Identifier Facility NPI Number

Required Pattern:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
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 Facility
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.Slices for type This element is included in summaries. 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.Slices for type.type:BFDR This element is included in summaries. 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
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 of Location
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
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string Unit Number
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 Street Address
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 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
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 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
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
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
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 Postal Code
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier.​type Base extensible IdentifierType 📍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.5
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
Location.type:BFDR Base required Location Types 📦2.0.0 This IG
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 Vital Records Common Library v2.0
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
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

This structure is derived from LocationVitalRecords

Summary

Mandatory: 2 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier
  • The element 1 is sliced based on the value of Location.type

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* LocationVitalRecords 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.Slices for identifier This element is included in summaries. 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension.extension:JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Location.Slices for identifier.identifier:All Slices.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Location.Slices for identifier.identifier:All Slices.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:NPI This element is included in summaries. 0..1 Identifier Facility NPI Number

Required Pattern:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
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 Facility
Location.Slices for type This element is included in summaries. 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.Slices for type.type:BFDR This element is included in summaries. 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
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 of Location
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string Unit Number
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 Street Address
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 City
Example General: Erewhon
Location.address.city.Slices for extension Content/Rules for all slices
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 County
Example General: Madison
Location.address.district.Slices for extension Content/Rules for all slices
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
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Location.address.state.Slices for extension Content/Rules for all slices
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 Postal Code
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string Country
Binding: Value Set - Residence Country Vital Records (required)
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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
Location.type:BFDR Base required Location Types 📦2.0.0 This IG
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 Vital Records Common Library v2.0
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from LocationVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* LocationVitalRecords Details and position information for a physical place
Location.Slices for identifier 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.Slices for extension.extension:JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
Location.Slices for identifier.identifier:All Slices.system 1..1 uri The namespace for the identifier value
Location.Slices for identifier.identifier:All Slices.value 1..1 string The value that is unique
Location.Slices for identifier.identifier:NPI 0..1 Identifier Facility NPI Number
Required Pattern:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Location.name 1..1 string Name of Facility
Location.Slices for type 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
Location.Slices for type.type:BFDR 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
Location.address 0..1 Address Address of Location
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:predir 0..1 ExtensionPreDirectionalVitalRecords Predirectional
Location.address.Slices for extension.extension:stnum 0..1 ExtensionStreetNumberVitalRecords Street Number
Location.address.Slices for extension.extension:stname 0..1 ExtensionStreetNameVitalRecords Street Name
Location.address.Slices for extension.extension:stdesig 0..1 ExtensionStreetDesignatorVitalRecords Street Designator
Location.address.Slices for extension.extension:postdir 0..1 ExtensionPostDirectionalVitalRecords Postdirectional
Location.address.Slices for extension.extension:unitnumber 0..1 ExtensionUnitOrAptNumberVitalRecords Unit Number
Location.address.line 0..* string Street Address
Location.address.city 0..1 string City
Location.address.district 0..1 string County
Location.address.state 0..1 string State
Location.address.postalCode 0..1 string Postal Code
Location.address.country 0..1 string Country

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.type:BFDR Base required Location Types 📦2.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* LocationVitalRecords 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.Slices for identifier This element is included in summaries. 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:All Slices.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:All Slices.Slices for extension.extension:JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Location.Slices for identifier.identifier:All Slices.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Location.Slices for identifier.identifier:All Slices.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Location.Slices for identifier.identifier:All Slices.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:NPI This element is included in summaries. 0..1 Identifier Facility NPI Number

Required Pattern:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
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 Facility
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.Slices for type This element is included in summaries. 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.Slices for type.type:BFDR This element is included in summaries. 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
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 of Location
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
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Location.address.Slices for extension.extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Location.address.Slices for extension.extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Location.address.Slices for extension.extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Location.address.Slices for extension.extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Location.address.Slices for extension.extension:unitnumber 0..1 string Unit Number
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 Street Address
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 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
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 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
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
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
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 Postal Code
Example General: 9132
Location.address.country This element is included in summaries. 0..1 string 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier.​type Base extensible IdentifierType 📍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.5
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
Location.type:BFDR Base required Location Types 📦2.0.0 This IG
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 Vital Records Common Library v2.0
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
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

This structure is derived from LocationVitalRecords

Summary

Mandatory: 2 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier
  • The element 1 is sliced based on the value of Location.type

 

Other representations of profile: CSV, Excel, Schematron