Birth And Fetal Death (BFDR) - STU2-ballot
2.0.0-Preview1 - trial-use United States of America flag

Birth And Fetal Death (BFDR) - STU2-ballot, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0-Preview1 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-Preview1
Active as of 2024-07-17 Computable Name: LocationBFDR
Other Identifiers: OID:2.16.840.1.113883.4.642.40.13.42.30

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

Usage:

Formal Views of Profile Content

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

This structure is derived from LocationVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location LocationVitalRecords
... Slices for identifier 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:NPI 0..1 Identifier Facility NPI Number
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... name 1..1 string Name of Facility
... Slices for type 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
.... type:BFDR 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
.... Slices for extension Content/Rules for all slices
..... extension:predir 0..1 ExtensionPreDirectionalVitalRecords Predirectional
..... extension:stnum 0..1 ExtensionStreetNumberVitalRecords Street Number
..... extension:stname 0..1 ExtensionStreetNameVitalRecords Street Name
..... extension:stdesig 0..1 ExtensionStreetDesignatorVitalRecords Street Designator
..... extension:postdir 0..1 ExtensionPostDirectionalVitalRecords Postdirectional
..... extension:unitnumber 0..1 ExtensionUnitOrAptNumberVitalRecords Unit Number
.... line 0..* string Street Address
.... city 0..1 string City
.... district 0..1 string County
.... state 0..1 string State
.... postalCode 0..1 string Postal Code
.... country 0..1 string Country

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.type:BFDRrequiredLocationTypeVS
http://hl7.org/fhir/us/bfdr/ValueSet/ValueSet-location-types
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* LocationVitalRecords Details and position information for a physical place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:NPI Σ 0..1 Identifier Facility NPI Number

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... name SΣ 1..1 string Name of Facility
... Slices for type Σ 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.


.... type:BFDR Σ 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Address of Location
.... Slices for extension Content/Rules for all slices
..... predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string Unit Number
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
.... line SΣ 0..* string Street Address
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 City
Example General: Erewhon
..... Slices for extension Content/Rules for all slices
...... cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district Σ 0..1 string County
Example General: Madison
..... Slices for extension Content/Rules for all slices
...... districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state SΣ 0..1 string State
Binding: States, Territories and Provinces Vital Records (required)
..... Slices for extension Content/Rules for all slices
...... nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Jurisdictions Vital Records (required)
.... postalCode SΣ 0..1 string Postal Code
Example General: 9132
.... country Σ 0..1 string Country
Binding: Residence Country Vital Records (required)
... managingOrganization SΣ 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
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.type:BFDRrequiredLocationTypeVS
http://hl7.org/fhir/us/bfdr/ValueSet/ValueSet-location-types
from this IG
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
Location.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* LocationVitalRecords 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
... 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
... Slices for identifier Σ 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... 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
...... JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of 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.

..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NPI Σ 0..1 Identifier Facility NPI Number

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 0..1 code active | suspended | 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 Facility
... 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.

... Slices for type Σ 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.


.... type:BFDR Σ 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Address of Location
.... 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
..... predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string Unit Number
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 Street Address
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 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
...... 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 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
...... 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
Binding: 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
...... nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Jurisdictions Vital Records (required)
..... value 0..1 string Primitive value for string
Max Length: 1048576
.... postalCode SΣ 0..1 string Postal Code
Example General: 9132
.... country Σ 0..1 string Country
Binding: 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:BFDRrequiredLocationTypeVS
http://hl7.org/fhir/us/bfdr/ValueSet/ValueSet-location-types
from this IG
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Location.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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

Differential View

This structure is derived from LocationVitalRecords

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location LocationVitalRecords
... Slices for identifier 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:NPI 0..1 Identifier Facility NPI Number
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... name 1..1 string Name of Facility
... Slices for type 1..* CodeableConcept Type is used to differentiate profiles of this abstract profile
Slice: Unordered, Open by value:$this
.... type:BFDR 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
.... Slices for extension Content/Rules for all slices
..... extension:predir 0..1 ExtensionPreDirectionalVitalRecords Predirectional
..... extension:stnum 0..1 ExtensionStreetNumberVitalRecords Street Number
..... extension:stname 0..1 ExtensionStreetNameVitalRecords Street Name
..... extension:stdesig 0..1 ExtensionStreetDesignatorVitalRecords Street Designator
..... extension:postdir 0..1 ExtensionPostDirectionalVitalRecords Postdirectional
..... extension:unitnumber 0..1 ExtensionUnitOrAptNumberVitalRecords Unit Number
.... line 0..* string Street Address
.... city 0..1 string City
.... district 0..1 string County
.... state 0..1 string State
.... postalCode 0..1 string Postal Code
.... country 0..1 string Country

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.type:BFDRrequiredLocationTypeVS
http://hl7.org/fhir/us/bfdr/ValueSet/ValueSet-location-types
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* LocationVitalRecords Details and position information for a physical place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:NPI Σ 0..1 Identifier Facility NPI Number

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... name SΣ 1..1 string Name of Facility
... Slices for type Σ 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.


.... type:BFDR Σ 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Address of Location
.... Slices for extension Content/Rules for all slices
..... predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string Unit Number
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
.... line SΣ 0..* string Street Address
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 City
Example General: Erewhon
..... Slices for extension Content/Rules for all slices
...... cityCode 0..1 positiveInt City Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district Σ 0..1 string County
Example General: Madison
..... Slices for extension Content/Rules for all slices
...... districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state SΣ 0..1 string State
Binding: States, Territories and Provinces Vital Records (required)
..... Slices for extension Content/Rules for all slices
...... nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Jurisdictions Vital Records (required)
.... postalCode SΣ 0..1 string Postal Code
Example General: 9132
.... country Σ 0..1 string Country
Binding: Residence Country Vital Records (required)
... managingOrganization SΣ 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
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.type:BFDRrequiredLocationTypeVS
http://hl7.org/fhir/us/bfdr/ValueSet/ValueSet-location-types
from this IG
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
Location.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* LocationVitalRecords 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
... 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
... Slices for identifier Σ 0..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... 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
...... JFI 0..1 string Jurisdictional Facility Identifier
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-jurisdictional-facility-identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of 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.

..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NPI Σ 0..1 Identifier Facility NPI Number

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 0..1 code active | suspended | 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 Facility
... 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.

... Slices for type Σ 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.


.... type:BFDR Σ 1..* CodeableConcept BFDR Location type
Binding: Location Types (required)
... telecom S 0..* ContactPoint Contact details of the location
... address S 0..1 Address Address of Location
.... 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
..... predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... unitnumber 0..1 string Unit Number
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 Street Address
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 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
...... 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 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
...... 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
Binding: 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
...... nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Jurisdictions Vital Records (required)
..... value 0..1 string Primitive value for string
Max Length: 1048576
.... postalCode SΣ 0..1 string Postal Code
Example General: 9132
.... country Σ 0..1 string Country
Binding: 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.type:BFDRrequiredLocationTypeVS
http://hl7.org/fhir/us/bfdr/ValueSet/ValueSet-location-types
from this IG
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Location.address.countryrequiredValueSetResidenceCountryVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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