National Healthcare Directory Exchange, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-exchange/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
fhir-national-directory |
Capabilities for a validated national directory server |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
Search by Connection Type in Endpoints |
Accesses the connection type of an Endpoint |
Search by Indentifer in Endpoints |
Accesses the identifier of an Endpoint |
Search by mime-type in Endpoints |
Accesses the mime-type of an Endpoint |
Search by organization in Endpoints |
Accesses the organization of an Endpoint |
Search by payload-type in Endpoints |
Accesses the payload-type of an Endpoint |
Search by status in Endpoints |
Accesses the status of an Endpoint |
Search by usecase-standard in Endpoints |
Accesses the usecase-standard of an Endpoint |
Search by usecase-type in Endpoints |
Accesses the usecase-type of an Endpoint |
Search by coverage-area in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by endpoint in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by location in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by name in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by organization in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by service-category in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by service-type in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by specialty in HealthcareService with multipleOr |
This SearchParameter enables query of HealthcareService by |
Search by administrated-by in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by coverage-area in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by coverage-benefit-type in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by coverage-network in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by identifier in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by name in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by owned-by in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by type in InsurancePlan with multipleOr |
This SearchParameter enables query of InsurancePlan by |
Search by address in Location with multipleOr |
This SearchParameter enables query of Location by |
Search by endpoint in Location with multipleOr |
This SearchParameter enables query of Location by |
Search by organization in Location with multipleOr |
This SearchParameter enables query of Location by |
Search by partOf in Location with multipleOr |
This SearchParameter enables query of Location by |
Search by physicalType in Location with multipleOr |
This SearchParameter enables query of Location by |
Search by type in Location with multipleOr |
This SearchParameter enables query of Location by |
Search by coverage-area in Network with multipleOr |
This SearchParameter enables query of Network by |
Search by name in Network with multipleOr |
This SearchParameter enables query of Network by |
Search by address in Organization with multipleOr |
This SearchParameter enables query of Organization by |
Search by endpoint in Organization with multipleOr |
This SearchParameter enables query of Organization by |
Search by identifier in Organization with multipleOr |
This SearchParameter enables query of Organization by |
Search by name in Organization with multipleOr |
This SearchParameter enables query of Organization by |
Search by partOf in Organization with multipleOr |
This SearchParameter enables query of Organization by |
Search by type in Organization with multipleOr |
This SearchParameter enables query of Organization by |
Search by endpoint in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by location in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by network in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by participating-organization in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by primary-organization in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by role in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by service in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by specialty in OrganizationAffiliation with multipleOr |
This SearchParameter enables query of Organization by |
Search by attestation-who in VerificationResult with multipleOr |
This SearchParameter enables query of VerificationResult by |
Search by primarysource-who in VerificationResult with multipleOr |
This SearchParameter enables query of VerificationResult by |
Search by target in InsurancePlan with multipleOr |
This SearchParameter enables query of VerificationResult by |
Search by category in CareTeam with multipleOr |
This SearchParameter enables query of Careteams by |
Search by endpoint in CareTeam with multipleOr |
This SearchParameter enables query of Careteams by |
Search by location in CareTeam with multipleOr |
This SearchParameter enables query of Careteams by |
Search by name in CareTeam with multipleOr |
This SearchParameter enables query of Careteams by |
Search by organization in CareTeam with multipleOr |
This SearchParameter enables query of Careteams by |
Search by service in CareTeam with multipleOr |
This SearchParameter enables query of Careteams by |
Search by family name in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by given name in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by identifier in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by identifier-assigner in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by name in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by qualification-code in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by qualification-issuer in practitioner with multipleOr |
This SearchParameter enables query of practitioner by |
Search by endpoint in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by location in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by network in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by organization in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by practitioner in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by role in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by service in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
Search by specialty in practitionerRole with multipleOr |
This SearchParameter enables query of practitionerRole by |
These define constraints on FHIR resources for systems conforming to this implementation guide.
National Directory Care Team |
Defines the basic constraints and extensions on the CareTeam resource for use in a Validated Healthcare Directory |
National Directory Endpoint |
The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging. |
National Directory HealthcareService |
The HealthCareService resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnostics, pharmacy, hospital and ambulatory care, home care, long-term care, and other health-related and community services. |
National Directory InsurancePlan |
An InsurancePlan is a discrete package of health insurance coverage benefits that are offered under a particular network type. A given payer’s products typically differ by network type and/or covered benefits. A plan pairs a product’s covered benefits with the particular cost sharing structure offered to a consumer. A given product may comprise multiple plans (i.e. each plan offers different cost sharing requirements for the same set of covered benefits). |
National Directory Location |
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. |
National Directory Network |
A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. A network is typically owned by a payer. |
National Directory Organization |
An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice. Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text |
National Directory OrganizationAffiliation |
The OrganizationAffiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information. |
National Directory Practitioner |
Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. |
National Directory PractitionerRole |
PractionerRole describes details about a provider, which can be a practitioner or an organization. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services to patients at a location. When the provider is a practitioner, there may also be a relationship to an organization. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization. |
National Directory Restriction |
Restriction describes details about a… |
National Directory Validation |
Validation describes details about… |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
Acme |
Payer Organization |
AcmeOfCTPortalEndpoint |
Endpoint for Acme of CT Portal |
AcmeQHPBronze |
Acme of CT QHP Bronze Plan |
AcmeQHPGold |
Acme of CT QHP Gold Plan |
AcmeofCTPremNet |
Acme of CT Premium Premium Network |
AcmeofCTStdNet |
Acme of CT Standard Network |
AnonRole |
Practitioner role that doesn’t refer to a specific practitioner |
BigBox |
Organization that Manages 2 of PharmChain’s pharmacies |
BurrClinic |
Burr Clinic provides service to Hartford Hospital |
BurrClinicAffil |
Burr Clinic’s affiliation with Acme of CT Provider Network and Hartford General Hospital |
BurrClinicServices |
Burr Clinic Services |
CancerClinic |
HartfordCancerClinicLLC |
CancerClinicLoc |
Location1 of Cancer Clinic |
CancerClinicService |
Cancer Clinic Services |
CareTeam1 |
Burr Clinic’s Care Team |
ConnHIE |
Connecticut HIE |
ConnHIEAffil |
Burr Clinic’s affiliation with Conn HIE |
Counselor |
Counselor Susie Smith |
CounselorRole1 |
Susie Smith is a counselor via Telemedicine |
HamiltonClinic |
Hamilton Clinic (a Division of Hartford Hospital) |
HamiltonClinicAffil |
Hamilton Clinic’s affiliation with Acme of CT Provider Network and Hartford General Hospital |
HamiltonClinicServices |
Hamilton Clinic Services |
HansSolo |
Solo Practitioner Hans Solo |
HansSoloClinic |
Location of Hans Solo’s clinic |
HansSoloRole1 |
Hans Solo is a solo practitioner |
HansSoloService |
Hans Solo Services |
HartfordOrthopedicAffil |
Hartford Orthopedic Services affiliation with Acme of CT Provider Network and Hartford General Hospital |
HartfordOrthopedicServices |
Hartford Orthopedic Services |
HartfordOrthopedics |
Hartford Orthpedic Services is a group providing Orthpods for Acme of CT at Hartford General Hospital |
HospERService |
Hartford General Hospital ER |
HospLoc1 |
Location1 of Hartford Hospital |
HospLoc2 |
Location2 of Hartford Hospital |
Hospital |
Hartford General Hospital |
JoeSmith |
Practitioner Dr Joe Smith |
JoeSmithRole1 |
Dr Smith moonlighting as ER Doc at Hartford Hospital |
JoeSmithRole2 |
Dr Smith Internal Medicine at Burr Clinic |
JoeSmithRole3 |
Dr Smith Admitting Privileges at Hartford General |
PatientConsent |
Patient that gives consent |
PharmChain |
Organization that Provides Pharmacy Services |
PharmChainAffil1 |
Organization Affiliation for PharmChain (Retail) |
PharmChainAffil2 |
Organization Affiliation for PharmChain (Compounding) |
PharmChainAffil3 |
Organization Affiliation for PharmChain (MailOrder) |
PharmChainCompService |
Compound Pharmacy Service provided by PharmacyOrganization A |
PharmChainMailService |
Mail Order Pharmacy Service provided by PharmacyOrganization A |
PharmChainRetailService |
Pharmacy Service provided by PharmChain |
PharmLoc1 |
Location of Pharmacy1 in PharmChain’s network |
PharmLoc2 |
Location of Pharmacy2 in PharmChain’s network |
PharmLoc3 |
Location of Pharmacy3 in PharmChain’s network |
PharmLoc4 |
Location of Pharmacy4 in PharmChain’s network |
ProviderAttestation |
Patient that gives consent |
StateOfCTLocation |
State of CT Area |
VirtualCounselService |
Virtual Counseling Service |