National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 United States of America flag

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, 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/fhir-us-ndh/ and changes regularly. See the Directory of published versions

Resource Profile: NDH Base OrganizationAffiliation Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-OrganizationAffiliation Version: 1.0.0
Standards status: Trial-use Computable Name: NdhOrganizationAffiliation

Copyright/Legal: HL7 International

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.

Background & Scope

OrganizationAffiliation resource is designed to outline connections between multiple organizations. This includes details on the services provided by one organization to another, the location(s) where services are available, the electronic endpoints used, and other relevant information.

OrganizationAffiliation is useful for defining relationships between organizations that do not have a hierarchical structure. For instance:

  • One organization may provide services to another organization
  • Two or more organizations may collaborate in a partnership or joint venture
  • An organization may be a member of another organization, without being owned by it (for example, a hospital can be a member of the American Hospital Association or a health information exchange network).

OrganizationAffiliation and practitionerRole share a similar structure. However, while practitionerRole references both practitioner and organization, OrganizationAffiliation involves references to a participatingOrg and an organization. The participating organization provides "services" to the primary organization, just as a practitioner provides services to an organization. To illustrate this, here are examples for the three cases mentioned earlier:

The participating organization provides services to the primary organization. In a joint venture, the joint venture itself is the primary organization, while partners within the joint venture are considered participating organizations. This requires two instances of the OrganizationAffiliation resource. In an association, the association is the primary organization, and its members are participating organizations. Additionally, OrganizationAffiliation is used to indicate when an organization provides services for a health insurance provider network.

Each instance has its own time period and can optionally include links to specific related services or locations that are accessible. These referenced locations or services should be associated with the participating organization and may available to the primary organization.

An OrganizationAffiliation role could encompass various healthcare services at multiple locations. When different locations provide distinct services, it is recommended to employ multiple OrganizationAffiliation resources and to separate them by location.

To associate an organization to an active network, it could be achieved by modifying the OrganizationAffiliation.period or for the organization. To change a network, it is necessary to create a new OrganizationAffiliation.

An organization has the capability to be affiliated with multiple networks. However, to ensure clarity and avoid confusion, it is recommended that each OrganizationAffiliation corresponds to only one network, even if the affiliations occur at different times.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C 0..* OrganizationAffiliation Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
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
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:qualification 0..* (Complex) Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:verification-status 0..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:logo 0..1 Attachment NDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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
.... Slices for extension Content/Rules for all slices
..... extension:identifier-status 0..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... assigner Σ 0..1 Reference(NDH Base Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... active Σ 1..1 boolean Whether this organization affiliation record is in active use
ele-1: All FHIR elements must have a @value or children
Required Pattern: true
... period SΣ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
ele-1: All FHIR elements must have a @value or children
... organization SΣ 0..1 Reference(NDH Base Organization Profile) Organization where the role is available
ele-1: All FHIR elements must have a @value or children
... participatingOrganization SΣ 0..1 Reference(NDH Base Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
ele-1: All FHIR elements must have a @value or children
... network Σ 0..* Reference(NDH Base Network Profile) Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
ele-1: All FHIR elements must have a @value or children
... code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
ele-1: All FHIR elements must have a @value or children
... specialty Σ 0..* CodeableConcept Specific specialty of the participatingOrganization in the context of the role
Binding: Healthcare Provider Taxonomy . (extensible)
ele-1: All FHIR elements must have a @value or children
... location SΣ 0..* Reference(NDH Base Location Profile) The location(s) at which the role occurs
ele-1: All FHIR elements must have a @value or children
... healthcareService 0..* Reference(NDH Base HealthcareService Profile) Healthcare services provided through the role
ele-1: All FHIR elements must have a @value or children
... endpoint S 0..* Reference(NDH Base Endpoint Profile) Technical endpoints providing access to services operated for this role
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
http://hl7.org/fhir/us/ndh/ValueSet/OrganizationAffiliationRoleVS
from this IG
OrganizationAffiliation.specialtyextensibleHealthcareProviderTaxonomy .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

Constraints

IdGradePath(s)DetailsRequirements
organization-or-participatingOrganizationerrorOrganizationAffiliationNdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
: organization.exists() or participatingOrganization.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

SearchParameter Name Type Example
location reference GET [base]/OrganizationAffiliation?location.address-state=CT
participating-organization reference GET [base]/OrganizationAffiliation?participating-organization.address-state=FL
primary-organization reference GET [base]/OrganizationAffiliation?primary-organization.address-state=FL
verification-status token GET [base]/OrganizationAffiliation?verification-status=complete

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

SearchParameter Name Type Example
endpoint reference GET [base]/OrganizationAffiliation?endpoint.connection-type=hl7-fhir-rest
identifier token GET [base]/OrganizationAffiliation?identifier=123456
network reference GET [base]/OrganizationAffiliation?network.type=ntwk&network.address-state=FL
role token GET [base]/OrganizationAffiliation?role=group
service reference GET [base]/OrganizationAffiliation?service.address-state=FL
specialty token GET [base]/OrganizationAffiliation?specialty=103T00000X

_include Search Parameter

_include Example
OrganizationAffiliation:network GET [base]/OrganizationAffiliation?_include=OrganizationAffiliation:network
OrganizationAffiliation:participating-organization GET [base]/OrganizationAffiliation?_include=OrganizationAffiliation:participating-organization
OrganizationAffiliation:primary-organization GET [base]/OrganizationAffiliation?_include=OrganizationAffiliation:primary-organization

_revinclude Search Parameter

None

Special Search Parameters

The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.

Why is the Qualification Extension Needed in Organization Affiliation?

The qualification extension in the OrganizationAffiliation Resource is significant as it offers a valid use case in real-world practice. For instance, an oncology group seeking privileges to practice in a hospital setting typically requires various approvals and certifications. This includes each physician in the group being licensed to practice medicine in the state where the hospital is located. Additionally, each physician must apply for and be granted the privilege to practice at the specific hospital. Furthermore, the oncology practice itself may also seek accreditation from organizations such as the Commission on Cancer (CoC) or the Quality Oncology Practice Initiative (QOPI), which can bolster its reputation and demonstrate a commitment to quality care. The qualifications of the oncology practice reflect its specific credential to the hospital where they practice. Although these qualifications can be documented in the oncology practice organization resource, an organization may have several qualifications, of which only certain ones are relevant to a specific practice setting. Therefore, it is necessary for both the OrganizationAffiliation Resource and the Organization Resource to include a qualification extension that serves different functions across various contexts.

Search OrganizationAffiliation resource based on the role of the participatingOrganization: Get [base]/OrganizationAffiliation?code=HieInitiator


Search OrganizationAffiliation resources which have participatingOrganization present: Get [base]/OrganizationAffiliation?_include=OrganizationAffiliation:participatingOrganization


Search Organization resource which associate with OrganizationAffiliation: Get [base]/Organization?_revinclude=OrganizationAffiliation:participatingOrganization