US Core Implementation Guide
8.0.0 - STU 8 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 8.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: 8.0.0
Standards status: Trial-use Computable Name: USCoreLocationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.35

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

The US Core Location Profile inherits from the FHIR Location resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Location resource for recording, searching, and fetching a "physical place of available services or resources." It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

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:

  • The data elements list has changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location 0..* Location Details and position information for a physical place
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... identifier SΣ 0..* Identifier Unique business identifier for facility or location.
    ele-1: All FHIR elements must have a @value or children
    ... status ?!SΣ 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.


    ele-1: All FHIR elements must have a @value or children
    ... name SΣ 1..1 string Name by which a facility or location is known.
    ele-1: All FHIR elements must have a @value or children
    ... type SΣ 0..* CodeableConcept Category of service or resource available in a location.
    Binding: US Core Location Type (extensible)
    ele-1: All FHIR elements must have a @value or children
    ... telecom S 0..* ContactPoint Contact details of the location
    ele-1: All FHIR elements must have a @value or children
    ... address S 0..1 Address Physical location
    ele-1: All FHIR elements must have a @value or children
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


    ele-1: All FHIR elements must have a @value or children
    Example General: home
    .... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
    ele-1: All FHIR elements must have a @value or children
    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..1 string Name of city, town etc.
    ele-1: All FHIR elements must have a @value or children
    Example General: Erewhon
    Example General: EVERYTOWN
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    ele-1: All FHIR elements must have a @value or children
    Example General: OK
    .... postalCode SΣ 0..1 string US Zip Codes
    ele-1: All FHIR elements must have a @value or children
    Example General: 9132
    Example General: 74047
    ... managingOrganization SΣ 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
    ele-1: All FHIR elements must have a @value or children

    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.typeextensibleUSCoreLocationType
    http://hl7.org/fhir/us/core/ValueSet/us-core-location-type
    from this IG
    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

     

    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 patients.

    US Core Scopes

    Servers providing access to data MAY 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)