US Core Implementation Guide
7.0.0 - CI Build United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Location Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location Version: 7.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreLocationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.42.31

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

This profile sets minimum expectations for the Location resource for recording, searching, and fetching a “physical place of available services or resources.” It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used when using the profile. It provides the floor for standards development for specific use cases to promote interoperability and adoption through common implementation.

Mandatory and Must Support Data Elements

The following data-elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Location Must Have:

  1. A name

Each Location Must Support:

  1. Location or facility identifier`
  2. A status (whether in use)
  3. The type of location or facility
  4. Contact details of the location
  5. A Location address*
  6. The managing organization

*see guidance below

Additional Profile specific implementation guidance:

Usage:

Changes since version 7.0.0-ballot:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed
  • Formal Views of Profile Content

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

    This structure is derived from Location

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..*LocationDetails and position information for a physical place
    ... identifier S0..*IdentifierUnique business identifier for facility or location.
    ... status S0..1codeactive | suspended | inactive
    ... name S1..1stringName by which a facility or location is known.
    ... type S0..*CodeableConceptCategory of service or resource available in a location.
    Binding: ServiceDeliveryLocationRoleType (extensible)
    ... telecom S0..*ContactPointContact details of the location
    ... address S0..1AddressPhysical location
    .... line S0..*stringStreet name, number, direction & P.O. Box etc.

    Example General: 49 MEADOW ST
    .... city S0..1stringName of city, town etc.
    Example General: EVERYTOWN
    .... state S0..1stringSub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    Example General: OK
    .... postalCode S0..1stringUS Zip Codes
    Example General: 74047
    ... managingOrganization S0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Location.typeextensibleServiceDeliveryLocationRoleType
    http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
    Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..*LocationDetails and position information for a physical place
    ... implicitRules ?!Σ0..1uriA set of rules under which this content was created
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... identifier SΣ0..*IdentifierUnique business identifier for facility or location.
    ... status ?!SΣ0..1codeactive | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.

    ... name SΣ1..1stringName by which a facility or location is known.
    ... type SΣ0..*CodeableConceptCategory of service or resource available in a location.
    Binding: ServiceDeliveryLocationRoleType (extensible)
    ... telecom S0..*ContactPointContact details of the location
    ... 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..*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
    Example General: 49 MEADOW ST
    .... city SΣ0..1stringName of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    .... state SΣ0..1stringSub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    Example General: OK
    .... postalCode SΣ0..1stringUS Zip Codes
    Example General: 9132
    Example General: 74047
    ... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Location.statusrequiredLocationStatus
    http://hl7.org/fhir/ValueSet/location-status|4.0.1
    from the FHIR Standard
    Location.typeextensibleServiceDeliveryLocationRoleType
    http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
    Location.address.userequiredAddressUse
    http://hl7.org/fhir/ValueSet/address-use|4.0.1
    from the FHIR Standard
    Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..*LocationDetails and position information for a physical place
    ... id Σ0..1idLogical id of this artifact
    ... meta Σ0..1MetaMetadata about the resource
    ... 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
    ... extension 0..*ExtensionAdditional content defined by implementations
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... identifier SΣ0..*IdentifierUnique business identifier for facility or location.
    ... status ?!SΣ0..1codeactive | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.

    ... 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 by which a facility or location is known.
    ... 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
    ... mode Σ0..1codeinstance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

    ... type SΣ0..*CodeableConceptCategory of service or resource available in a location.
    Binding: ServiceDeliveryLocationRoleType (extensible)
    ... telecom S0..*ContactPointContact details of the location
    ... 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
    Example General: 49 MEADOW ST
    .... city SΣ0..1stringName of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    .... 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.


    Example General: OK
    .... postalCode SΣ0..1stringUS Zip Codes
    Example General: 9132
    Example General: 74047
    .... 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 Σ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(US Core Organization Profile)Organization responsible for provisioning and upkeep
    ... partOf 0..1Reference(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 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.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.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.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG
    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

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Location

    Summary

    Mandatory: 1 element
    Must-Support: 11 elements

    Structures

    This structure refers to these other structures:

    Maturity: 3

    Differential View

    This structure is derived from Location

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..*LocationDetails and position information for a physical place
    ... identifier S0..*IdentifierUnique business identifier for facility or location.
    ... status S0..1codeactive | suspended | inactive
    ... name S1..1stringName by which a facility or location is known.
    ... type S0..*CodeableConceptCategory of service or resource available in a location.
    Binding: ServiceDeliveryLocationRoleType (extensible)
    ... telecom S0..*ContactPointContact details of the location
    ... address S0..1AddressPhysical location
    .... line S0..*stringStreet name, number, direction & P.O. Box etc.

    Example General: 49 MEADOW ST
    .... city S0..1stringName of city, town etc.
    Example General: EVERYTOWN
    .... state S0..1stringSub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    Example General: OK
    .... postalCode S0..1stringUS Zip Codes
    Example General: 74047
    ... managingOrganization S0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Location.typeextensibleServiceDeliveryLocationRoleType
    http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
    Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..*LocationDetails and position information for a physical place
    ... implicitRules ?!Σ0..1uriA set of rules under which this content was created
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... identifier SΣ0..*IdentifierUnique business identifier for facility or location.
    ... status ?!SΣ0..1codeactive | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.

    ... name SΣ1..1stringName by which a facility or location is known.
    ... type SΣ0..*CodeableConceptCategory of service or resource available in a location.
    Binding: ServiceDeliveryLocationRoleType (extensible)
    ... telecom S0..*ContactPointContact details of the location
    ... 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..*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
    Example General: 49 MEADOW ST
    .... city SΣ0..1stringName of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    .... state SΣ0..1stringSub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    Example General: OK
    .... postalCode SΣ0..1stringUS Zip Codes
    Example General: 9132
    Example General: 74047
    ... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Location.statusrequiredLocationStatus
    http://hl7.org/fhir/ValueSet/location-status|4.0.1
    from the FHIR Standard
    Location.typeextensibleServiceDeliveryLocationRoleType
    http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
    Location.address.userequiredAddressUse
    http://hl7.org/fhir/ValueSet/address-use|4.0.1
    from the FHIR Standard
    Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..*LocationDetails and position information for a physical place
    ... id Σ0..1idLogical id of this artifact
    ... meta Σ0..1MetaMetadata about the resource
    ... 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
    ... extension 0..*ExtensionAdditional content defined by implementations
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... identifier SΣ0..*IdentifierUnique business identifier for facility or location.
    ... status ?!SΣ0..1codeactive | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.

    ... 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 by which a facility or location is known.
    ... 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
    ... mode Σ0..1codeinstance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

    ... type SΣ0..*CodeableConceptCategory of service or resource available in a location.
    Binding: ServiceDeliveryLocationRoleType (extensible)
    ... telecom S0..*ContactPointContact details of the location
    ... 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
    Example General: 49 MEADOW ST
    .... city SΣ0..1stringName of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    .... 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.


    Example General: OK
    .... postalCode SΣ0..1stringUS Zip Codes
    Example General: 9132
    Example General: 74047
    .... 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 Σ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(US Core Organization Profile)Organization responsible for provisioning and upkeep
    ... partOf 0..1Reference(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 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.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.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.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG
    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

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorLocationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Location

    Summary

    Mandatory: 1 element
    Must-Support: 11 elements

    Structures

    This structure refers to these other structures:

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple <patient user system>s.

    US Core Scopes

    Servers providing access to data SHALL support these US Core SMART Scopes:

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching by location name using the name search parameter:

      GET [base]/Location?name=[string]

      Example:

      1. GET [base]/Location?name=Health

      Implementation Notes: Fetches a bundle of all Location resources that match the name (how to search by string)

    2. SHALL support searching location based on text address using the address search parameter:

      GET [base]/Location?address=[string]

      Example:

      1. GET [base]/Location?address=Arbor

      Implementation Notes: Fetches a bundle of all Location resources that match the address string (how to search by string)

    Optional Search Parameters:

    The following search parameter combinations SHOULD be supported:

    1. SHOULD support searching using the address-city search parameter:

      GET [base]/Location?address-city=[string]

      Example:

      1. GET [base]/Location?address-city=Ann Arbor

      Implementation Notes: Fetches a bundle of all Location resources for the city (how to search by string)

    2. SHOULD support searching using the address-state search parameter:

      GET [base]/Location?address-state=[string]

      Example:

      1. GET [base]/Location?address-state=MI

      Implementation Notes: Fetches a bundle of all Location resources for the state (how to search by string)

    3. SHOULD support searching using the address-postalcode search parameter:

      GET [base]/Location?address-postalcode=[string]

      Example:

      1. GET [base]/Location?address-postalcode=48104

      Implementation Notes: Fetches a bundle of all Location resources for the ZIP code (how to search by string)