Validated Healthcare Directory
1.0.0 - STU1 International flag

Validated Healthcare Directory, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions

Home

Official URL: http://hl7.org/fhir/uv/vhdir/ImplementationGuide/hl7.fhir.uv.vhdir Version: 1.0.0
Active as of 2022-02-15 Computable Name: ValidatedHealthcareDirectory

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

Introduction

The Validated Healthcare Directory Implementation Guide (VHDir IG) is based on FHIR Version 4.0. It was developed in cooperation with the Office of the National Coordinator for Health Information Technology (ONC) and Federal Health Architecture (FHA) with guidance from HL7 International, the Patient Administration Workgroup, and the HL7 US Realm Steering Committee.

It describes the architectural considerations for attesting to, validating, and exchanging data from a central source of validated provider data (i.e. a Validated Healthcare Directory or VHDir), as well as a RESTful FHIR API for accessing data from a VHDir.

Although we developed this guide from the conceptual starting point of a national source of validated provider data, we recognize that implementers may have different business needs, contexts, or use cases. Therefore, we have strived to make this guide as broadly applicable as possible. Every implementation may not use all of the content in this guide. It serves as a “floor” for the exchange of validated provider data, while describing additional data elements and capabilities that support more robust implementations.

Likewise, we provide general guidance about the technical architecture and capabilities of a central source of validated provider data, but are not prescriptive about what an implementation must include.

For more information on the history of Validated Healthcare Directory see the Validated Healthcare Directory change notes.

Primary Authors: Dan Chaput, Alex Kontur, Brian Postlethwaite, Bob Dieterle

Validated Healthcare Directory Profiles

The list of Validated Healthcare Directory Profiles is shown below. Each profile defines the minimum mandatory elements, extensions and terminology requirements that MUST be present. For each profile, requirements and guidance are given in a simple narrative summary. A formal hierarchical table that presents a logical view of the content in both a differential and snapshot view is also provided along with references to appropriate terminologies and examples. In addition each profile has a "Quick Start" section which is intended as an implementer friendly overview of the required search and read operations.

  • VhDir Care Team
  • VhDir Endpoint
  • VhDir Healthcare Service
  • VhDir Insurance Plan
  • VhDir Location
  • VhDir Network
  • VhDir Organization
  • VhDir Organization Affiliation
  • VhDir Practitioner
  • VhDir Practitioner Role
  • VhDir Restriction
  • VhDir Validation

    • Globals Profiles

    There are no Global profiles defined

    Package Dependencies

    IGPackageFHIRComment
    .. Validated Healthcare Directoryhl7.fhir.uv.vhdir#1.0.0R4
    ... HL7 Terminology (THO)hl7.terminology.r4#6.0.2R4Automatically added as a dependency - all IGs depend on HL7 Terminology
    ... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.1.0R4Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
    ... Bulk Data Access IGhl7.fhir.uv.bulkdata#2.0.0R4
    ... SMART App Launchhl7.fhir.uv.smart-app-launch#2.1.0R4
    .... HL7 Terminology (THO)hl7.terminology.r4#5.0.0R4

    Package hl7.fhir.uv.extensions.r4#5.1.0

    This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

    Package hl7.fhir.uv.bulkdata#2.0.0

    FHIR based approach for exporting large data sets from a FHIR server to a client application (built Fri, Nov 26, 2021 05:56+1100+11:00)

    Cross Version Analysis

    This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.uv.vhdir.r4) and R4B (hl7.fhir.uv.vhdir.r4b) are available.

    Validated Healthcare Directory Conformance Requirements

    The Capability Statements Section outlines conformance requirements for Validated Healthcare Directory Servers and Client applications, identifying the specific profiles, RESTful operations and search parameters that need to be supported.

    Note: The individual Validated Healthcare Directory profiles identify the structural constraints, terminology bindings and invariants, however, implementers must refer to the conformance requirements for details on the RESTful operations, specific profiles and the search parameters applicable to each of the Validated Healthcare Directory actors.

    Intellectual Property Considerations

    This publication includes IP covered under the following statements.