National Healthcare Directory Query
1.0.0-ballot - ballot US

This page is part of the National Healthcare Query (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: National Directory Endpoint Qry Exchange Location

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Location Version: 1.0.0-ballot
Active as of 2022-08-09 Computable Name: NatlDirEndpointQryLocation

A Location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... accessibility 0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility
Binding: Accessibility Value Set (extensible)
... region 0..1AttachmentAssociated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... status 1..1codeactive | suspended | inactive
Fixed Value: active
... mode 0..0
... type S0..*CodeableConceptType of function performed
... telecom
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
... physicalType S0..1CodeableConceptPhysical form of the location
... managingOrganization 0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(National Directory Endpoint Qry Exchange Location)Another Location this one is physically a part of
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... accessibility 0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility
Binding: Accessibility Value Set (extensible)
... newpatients I0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... region 0..1AttachmentAssociated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... operationalStatus Σ0..1CodingThe 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..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(National Directory Endpoint Qry Exchange Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... status ?!Σ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... name Σ1..1stringName of the location as used by humans
... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... address 0..1AddressPhysical location
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringName of city, town etc.
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ0..1stringUS Zip Codes
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... managingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(National Directory Endpoint Qry Exchange Location)Another Location this one is physically a part of
... endpoint 0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... accessibility 0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility
Binding: Accessibility Value Set (extensible)
... region 0..1AttachmentAssociated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... status 1..1codeactive | suspended | inactive
Fixed Value: active
... mode 0..0
... type S0..*CodeableConceptType of function performed
... telecom
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
... physicalType S0..1CodeableConceptPhysical form of the location
... managingOrganization 0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(National Directory Endpoint Qry Exchange Location)Another Location this one is physically a part of
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... accessibility 0..*CodeableConceptAccessibility
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/accessibility
Binding: Accessibility Value Set (extensible)
... newpatients I0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... region 0..1AttachmentAssociated Region (GeoJSON)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... operationalStatus Σ0..1CodingThe 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..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type SΣ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom S0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address S0..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(National Directory Endpoint Qry Exchange Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Location.meta.securityextensibleAll Security Labels
Location.meta.tagexampleCommonTags
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.statusrequiredFixed Value: active
Location.operationalStatuspreferredHl7VSBedStatus
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek