National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: Payer Provider Network Query Location Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPnQry-Location Version: 1.0.0-ballot
Active as of 2023-07-30 Computable Name: NdhPnQryLocation

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 NdhLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*NdhLocationDetails and position information for a physical place
... extension:location-boundary-geojson S0..1boundary-geojsonA boundary shape that represents the outside edge of the location (in GeoJSON format)
... extension:accessibility S0..*AccessibilityNDH Accessibility
... extension:newpatients S0..*NewPatientsNDH New Patients
.... type S0..1CodeableConceptDescription of identifier
.... value S0..1stringThe value that is unique
.... assigner 0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description S0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode 0..0
... telecom
.... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
.... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
... position S0..1BackboneElementThe absolute geographic location
... managingOrganization 0..1Reference(Payer Provider Network Query Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Payer Provider Network Query Location Profile)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Payer Provider Network Query Endpoint Profile)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*NdhLocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... location-boundary-geojson S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription 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.

.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... name SΣ1..1stringName of the location as used by humans
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ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
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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.

... address S0..1AddressPhysical location
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..4stringStreet 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
.... 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 SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... position S0..1BackboneElementThe absolute geographic location
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
... managingOrganization SΣ0..1Reference(Payer Provider Network Query Organization Profile)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Payer Provider Network Query Location Profile)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Payer Provider Network Query Endpoint Profile)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.identifier.userequiredIdentifierUse
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*NdhLocationDetails and position information for a physical place
... id Σ0..1idLogical 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
... location-boundary-geojson S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... newpatients SC0..*(Complex)NDH New Patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... 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 S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ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 S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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..4stringStreet 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 SΣ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 Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S0..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(Payer Provider Network Query Organization Profile)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Payer Provider Network Query Location Profile)Another Location this one is physically a part of
... hoursOfOperation S0..*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 S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Payer Provider Network Query Endpoint Profile)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.meta.securityextensibleAll Security Labels
Location.meta.tagexampleCommonTags
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredIdentifierUse
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.operationalStatuspreferredHl7VSBedStatus
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Differential View

This structure is derived from NdhLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*NdhLocationDetails and position information for a physical place
... extension:location-boundary-geojson S0..1boundary-geojsonA boundary shape that represents the outside edge of the location (in GeoJSON format)
... extension:accessibility S0..*AccessibilityNDH Accessibility
... extension:newpatients S0..*NewPatientsNDH New Patients
.... type S0..1CodeableConceptDescription of identifier
.... value S0..1stringThe value that is unique
.... assigner 0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description S0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode 0..0
... telecom
.... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
.... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
... position S0..1BackboneElementThe absolute geographic location
... managingOrganization 0..1Reference(Payer Provider Network Query Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Payer Provider Network Query Location Profile)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Payer Provider Network Query Endpoint Profile)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*NdhLocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... location-boundary-geojson S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription 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.

.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


Fixed Value: active
... name SΣ1..1stringName of the location as used by humans
... alias S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ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
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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.

... address S0..1AddressPhysical location
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..4stringStreet 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
.... 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 SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... position S0..1BackboneElementThe absolute geographic location
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
... managingOrganization SΣ0..1Reference(Payer Provider Network Query Organization Profile)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Payer Provider Network Query Location Profile)Another Location this one is physically a part of
... hoursOfOperation S0..*BackboneElementWhat days/times during a week is this location usually open
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Payer Provider Network Query Endpoint Profile)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.identifier.userequiredIdentifierUse
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*NdhLocationDetails and position information for a physical place
... id Σ0..1idLogical 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
... location-boundary-geojson S0..1AttachmentA boundary shape that represents the outside edge of the location (in GeoJSON format)
URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... newpatients SC0..*(Complex)NDH New Patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... 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 S0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ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 S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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..4stringStreet 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 SΣ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 Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position S0..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(Payer Provider Network Query Organization Profile)Organization responsible for provisioning and upkeep
... partOf S0..1Reference(Payer Provider Network Query Location Profile)Another Location this one is physically a part of
... hoursOfOperation S0..*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 S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanThe Location is open all day
.... openingTime S0..1timeTime that the Location opens
.... closingTime S0..1timeTime that the Location closes
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Payer Provider Network Query Endpoint Profile)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.meta.securityextensibleAll Security Labels
Location.meta.tagexampleCommonTags
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredIdentifierUse
Location.identifier.typeextensibleIdentifier Type Codes
Location.statusrequiredFixed Value: active
Location.operationalStatuspreferredHl7VSBedStatus
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

 

Other representations of profile: CSV, Excel, Schematron