# National Directory API Examples - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v2.0.0-current

* [**Table of Contents**](toc.md)
* **National Directory API Examples**

## National Directory API Examples

| |
| :--- |
| *Page standards status:*[Informative](http://hl7.org/fhir/R4/versions.html#std-process) |

### Exchange Examples

#### Social Service

##### Social Service diagram for example

* [HealthcareService/HealthcareService-Social-Hope-CBO](HealthcareService-HealthcareService-Social-Hope-CBO.md)
* [HealthcareService/HealthcareService-Social-Towson-Food](HealthcareService-HealthcareService-Social-Towson-Food.md)
* [Location/Location-Social-Hope-CBO](Location-Location-Social-Hope-CBO.md)
* [Location/Location-Social-Towson-Food](Location-Location-Social-Towson-Food.md)
* [Organization/Organization-Social-Hope-CBO](Organization-Organization-Social-Hope-CBO.md)
* [Organization/Organization-Social-Towson-Food](Organization-Organization-Social-Towson-Food.md)

#### PractitionerRole

PractitionerRole describes the relationship between a practitioner and an organization. A practitioner provides services to the organization at a location. Practitioners also participate in healthcare provider insurance networks through their role at an organization.

##### Examples associated with this PractitionerRole

Dr. Hans Solo operates a private practice within the Hans Solo Clinic, offering primary healthcare services. He is an active participant in the Blue Cross Blue Shield Connecticut PPO network, which is covered by the Blue Cross Blue Shield Connecticut Insurance Plan.

Patients can effortlessly locate Dr. Solo by searching his name, specialty, or location. The search results provide comprehensive information, including the location and type of service offered, the clinic's working hours, acceptance of new patients, types of insurance honored, and an electronic link to access patient medical records.

Other healthcare organizations also have the ability to access Dr. Solo's practice endpoint, providing a secure route to patient medical records or to transmit referral details.

Moreover, the Blue Cross Blue Shield PPO Network can utilize Dr. Solo's practice endpoint to retrieve patient medical data for claim processing and pre-authorization procedures.

* [PractitionerRole/HansSoloRole](PractitionerRole-HansSoloRole.md)
* [Practitioner/HansSolo](Practitioner-HansSolo.md)
* [Location/HansSoloClinic](Location-HansSoloClinic.md)
* [HealthcareService/HansSoloService](HealthcareService-HansSoloService.md)
* [Organization/BlueCrossBlueShield-CT-PPO](Organization-BlueCrossBlueShield-CT-PPO.md)
* [Organization/BlueCrossBlueShield-CT-ORG](Organization-BlueCrossBlueShield-CT-ORG.md)
* [InsurancePlan/BlueCrossBlueShield-CT](InsurancePlan-BlueCrossBlueShield-CT.md)
* [Endpoint/HansSoloDirectTrustEndpointReferrals](Endpoint-HansSoloDirectTrustEndpointReferrals.md)
* [Endpoint/HansSoloPatientAccessEndpoint](Endpoint-HansSoloPatientAccessEndpoint.md)

##### Practitioner and Networks.

Practitioners have the flexibility to engage in multiple insurance networks concurrently. They are also afforded the liberty to disengage from a network or integrate into a new one. The NDH has established infrastructure, utilizing PractitionerRole, to facilitate these transitions.

In the duration from June 1, 2023, to December 31, 2023, a practitioner, referred to as Network1andNetwork2 PractitionerOne, is actively involved in both the Network1 and Network2, under the administration of OMPN, an organization responsible for managing payer networks.

However, by the end of 2023, the practitioner plans to withdraw from Network1. Meanwhile, the practitioner commenced their affiliation with Network2 on June 1, 2023.

* [Network1](Organization-Network1.md)
* [Network2](Organization-Network2.md)
* [OrgManageNetwork](Organization-OrgManageNetwork.md)
* [PractitionerOneWithNetwork1AndNetwork2](Practitioner-PractitionerOneWithNetwork1AndNetwork2.md)
* [PractitionerOneNetwork1Role](PractitionerRole-PractitionerOneNetwork1Role.md)
* [PractitionerOneNetwork2Role](PractitionerRole-PractitionerOneNetwork2Role.md)
* [MedicareAdvantageHMO](InsurancePlan-MedicareAdvantageHMO.md)
* [MedicareAdvantage](InsurancePlan-MedicareAdvantage.md)

##### OrganizationAffliliation and Networks.

Organizations could participate in several insurance networks simultaneously. They possess the freedom to disconnect from an existing network or assimilate into a new one. The NDH has crafted an infrastructure, through OrganizationAffiliation, to streamline such transitions.

From June 1, 2023, through December 31, 2023, an organization named OrgOneWithNetwork1AndNetwork2 is actively engaged with both the Network1 and Network2 networks. This participation is supervised by OMPN, an entity tasked with overseeing payer networks.

Nevertheless, by the close of 2023, the organization anticipates severing its ties with the Network1 network. Concurrently, the organization initiated its association with the Network2 network starting on June 1, 2023.

* [Network1](Organization-Network1.md)
* [Network2](Organization-Network2.md)
* [OrgManageNetwork](Organization-OrgManageNetwork.md)
* [OrgOneNetwork1Affiliation](OrganizationAffiliation-OrgOneNetwork1Affiliation.md)
* [OrgOneNetwork2Affiliation](OrganizationAffiliation-OrgOneNetwork2Affiliation.md)
* [OrgOneWithNetwork1AndNetwork2](Organization-OrgOneWithNetwork1AndNetwork2.md)
* [MedicareAdvantageHMO](InsurancePlan-MedicareAdvantageHMO.md)
* [MedicareAdvantage](InsurancePlan-MedicareAdvantage.md)

##### HealthcareService and Networks without InsurancePlan

Typically, healthcare service networks are tied to insurance plans. However, in the realm of social services, the delivery or subscription of services often occurs through a hub. This hub embodies a similar concept to a network, but without an insurance plan attached. To simplify the process of locating such hubs (networks), NDH offers a connection from the healthcare server to the network. For instance, the Welcome Home organization provides housing services at the Welcome Home location. This service is subscribed to through the Social Service Housing Network.

* [HealthcareServiceHomelessAssistance](HealthcareService-HealthcareServiceHomelessAssistance.md)
* [OrgHousingAssistanceHubManagement](Organization-OrgHousingAssistanceHubManagement.md)
* [OrganizationWelcomeHome](Organization-OrganizationWelcomeHome.md)
* [LocationWelcomeHome](Location-LocationWelcomeHome.md)
* [SocialServiceHousingNetwork](Organization-SocialServiceHousingNetwork.md)

#### OrganizationAffiliation

Similar to PractitionerRole, OrganizationAffiliation describes relationships between organizations.

##### OrganizationAffiliation among clinic, hospital, network, and insurance plan

###### OrganizationAffiliation relationship diagram for example

###### Examples associated with this OrganizationAffiliation

* ****[OrganizationAffiliation/BurrClinicAffil](OrganizationAffiliation-BurrClinicAffil.md)****
* ****[Organization/BurrClinic](Organization-BurrClinic.md)****
* ****[Organization/AcmeofCTStdNet](Organization-AcmeofCTStdNet.md)****
* ****[Organization/Acme](Organization-Acme.md)****
* ****[Organization/Hospital](Organization-Hospital.md)****
* ****[Organization/AcmeofCTPremNet](Organization-AcmeofCTPremNet.md)****
* ****[Location/HospLoc1](Location-HospLoc1.md)****
* ****[Location/HospLoc2](Location-HospLoc2.md)****
* ****[Location/StateOfCTLocation](Location-StateOfCTLocation.md)****
* ****[HealthcareService/BurrClinicServices](HealthcareService-BurrClinicServices.md)****
* ****[InsurancePlan/AcmeQHPGold](InsurancePlan-AcmeQHPGold.md)****
* ****[Endpoint/AcmeOfCTPortalEndpoint](Endpoint-AcmeOfCTPortalEndpoint.md)****

##### OrganizationAffiliation among pharmacy chain

###### Pharmacy chain OrganizationAffiliation relationship diagram for example

###### Examples associated with this OrganiztionAffiliation

* ****[OrganizationAffiliation/PharmChainAffil1](OrganizationAffiliation-PharmChainAffil1.md)****
* ****[Organization/PharmChain](Organization-PharmChain.md)****
* ****[Organization/AcmeofCTStdNet](Organization-AcmeofCTStdNet.md)****
* ****[Organization/BigBox](Organization-BigBox.md)****
* ****[Organization/Acme](Organization-Acme.md)****
* ****[Location/PharmLoc1](Location-PharmLoc1.md)****
* ****[Location/PharmLoc2](Location-PharmLoc2.md)****
* ****[Location/PharmLoc3](Location-PharmLoc3.md)****
* ****[Location/PharmLoc4](Location-PharmLoc4.md)****
* ****[HealthcareService/PharmChainRetailService](HealthcareService-PharmChainRetailService.md)****

