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

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, 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-ballot
Active as of 2023-07-30 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.

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... identifier S0..*IdentifierBusiness identifiers that are specific to this role
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... active 1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period S0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization S0..1Reference(NDH Base Organization Profile)Organization where the role is available
... participatingOrganization S0..1Reference(NDH Base Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... 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)
... code 0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty 0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties Value Set (extensible)
... location S0..*Reference(NDH Base Location Profile)The location(s) at which the role occurs
... healthcareService 0..*Reference(NDH Base HealthcareService Profile)Healthcare services provided through the role
... telecom
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyextensibleSpecialtiesVS

Constraints

IdGradePath(s)DetailsRequirements
organization-or-participatingOrganizationerrorOrganizationAffiliationNdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
: organization.exists() or participatingOrganization.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(NDH Base Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... 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)
... code Σ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty Σ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties Value Set (extensible)
... location SΣ0..*Reference(NDH Base Location Profile)The location(s) at which the role occurs
... healthcareService 0..*Reference(NDH Base HealthcareService Profile)Healthcare services provided through the role
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyextensibleSpecialtiesVS

Constraints

IdGradePath(s)DetailsRequirements
organization-or-participatingOrganizationerrorOrganizationAffiliationNdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
: organization.exists() or participatingOrganization.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(NDH Base Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... 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)
... code Σ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty Σ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties Value Set (extensible)
... location SΣ0..*Reference(NDH Base Location Profile)The location(s) at which the role occurs
... healthcareService 0..*Reference(NDH Base HealthcareService Profile)Healthcare services provided through the role
... telecom Σ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.meta.securityextensibleAll Security Labels
OrganizationAffiliation.meta.tagexampleCommonTags
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyextensibleSpecialtiesVS
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

Differential View

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... identifier S0..*IdentifierBusiness identifiers that are specific to this role
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... active 1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period S0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization S0..1Reference(NDH Base Organization Profile)Organization where the role is available
... participatingOrganization S0..1Reference(NDH Base Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... 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)
... code 0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty 0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties Value Set (extensible)
... location S0..*Reference(NDH Base Location Profile)The location(s) at which the role occurs
... healthcareService 0..*Reference(NDH Base HealthcareService Profile)Healthcare services provided through the role
... telecom
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyextensibleSpecialtiesVS

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(NDH Base Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... 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)
... code Σ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty Σ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties Value Set (extensible)
... location SΣ0..*Reference(NDH Base Location Profile)The location(s) at which the role occurs
... healthcareService 0..*Reference(NDH Base HealthcareService Profile)Healthcare services provided through the role
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyextensibleSpecialtiesVS

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
organization-or-participatingOrganization: NdhOrganizationAffiliation.organization or NdhOrganizationAffiliation.participatingOrganization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(NDH Base Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... 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)
... code Σ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty Σ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Specialties Value Set (extensible)
... location SΣ0..*Reference(NDH Base Location Profile)The location(s) at which the role occurs
... healthcareService 0..*Reference(NDH Base HealthcareService Profile)Healthcare services provided through the role
... telecom Σ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.meta.securityextensibleAll Security Labels
OrganizationAffiliation.meta.tagexampleCommonTags
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyextensibleSpecialtiesVS
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

None

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
location reference GET [base]/OrganizationAffiliation?location.address-state=FL
network reference GET [base]/OrganizationAffiliation?network.type=ntwk&network.address-state=FL
participating-organization reference GET [base]/OrganizationAffiliation?participating-organization.address-state=FL
primary-organization reference GET [base]/OrganizationAffiliation?primary-organization.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

Use cases for supporting IHE networks

NDH adopts the approach proposed in the IHE White Paper “Document Sharing Across Network Topologies” by utilizing the NDH OrganizationAffiliation resource to accommodate the various scenarios for federated, multi-hop, and proxied Endpoints. Specifically, we address how to represent the structure in the National Directory and ensure the successful execution of federated transactions, such as sending an XDR push to a Document Recipient, intended for one or more recipients. The approach also includes implementing specific mechanisms to solve particular problems, allowing each environment to only adopt the mechanisms it requires. For instance, if a directory can declare that all Organization.partOf relationships imply the flow of federated data, the OrganizationAffiliation profile may not be necessary. It is essential to ensure that all mechanisms work seamlessly together within the National Directory, taking into account multiple networks and perspectives.

An Example from IHE “Document Sharing Across Network Topologies” White Paper.

  • Valley Region HIE has joined a nationwide health information exchange, Big Health Exchange.
  • Big Health Exchange doesn’t have any central service endpoints; it is peer to peer.
  • New Hope is in Big Health Exchange to show how it has access the desired organizations by virtue of Valley HIE’s participation in Big Health. New Hope will get to these organizations through the endpoints “Valley BigHx Responding Gateway”.
  • Valley HIE is leaving its PDQ and XDS internal service endpoints for its members, but has added initiating gateway endpoints for its members to access Big Health (as well as aggregate internal data).
  • Async endpoints and their response endpoints to show that even though members of Valley HIE utilize central services, they need individual async endpoints to receive responses.

This example provides answers to the following questions:

  1. Is it possible to locate the endpoint in the National Directory?
  2. Can the endpoints be accessed by members of the organization?
  3. Is it appropriate to use the endpoint for the task at hand?

More infromation in the White Paper

HIE Access Multi-Level-Community:Organizationname = "Big Health Exchange"OrgID = 7.8.9:Organizationname = "New HopeMedical Partners"New Hope BigHx External Initiating Gateway : Endpoint(s)ihe-specific-connection-type =XCPD-InitGateway-PatientDiscovery-AsyncResponse,XCA-InitGateway-Query-AsyncResponse,XCA-InitGateway-Retrieve-AsyncResponseorgAff4:OrganizationAffiliationcode = “HIEResponder”:Organizationname = "Valley Region HIE"OrgID = 1.2.3.0HCID = 1.2.3orgAff5:OrganizationAffiliationcode = “HIEResponder”Valley BigHx Responding Gateway : Endpoint(s)ihe-specific-connection-type =XCPD-RespGateway-PatientDiscovery,XCPD-RespGateway-PatientDiscovery-Async,XCA-RespGateway-Query,XCA-RespGateway-Retrieve,XCA-RespGateway-Query-Async,XCA-RespGateway-Retrieve-AsyncValley BigHx External Initiating Gateway : Endpoint(s)ihe-specific-connection-type =XCPD-InitGateway-PatientDiscovery-AsyncResponse,XCA-InitGateway-Query-AsyncResponse,XCA-InitGateway-Retrieve-AsyncResponseValley BigHx Internal Initiating Gateway : Endpoint(s)ihe-specific-connection-type =XCPD-RespGateway-PatientDiscovery,XCPD-RespGateway-PatientDiscovery-Async,XCA-InitGateway-Query,XCA-InitGateway-Retrieve,XCA-InitGateway-Query-Async,XCA-InitGateway-Retrieve-AsyncValley HIE Centralized Services : Endpoint(s)ihe-specific-connection-type =PDQ-Supplier-Query,XDS-Registry-Query,XDS-Registry-Query-Async,XDS-Repository-Retrieve,XDS-Repository-Retrieve-Async,XDS-OnDemandSource-Retrieve,XDS-OnDemandSource-Retrieve-Async:Organizationname = "University Health"alias = "OU Health System","OU Health"OrgID = 1.2.3.3:Organizationname = "Urgent Health"OrgID = 4.5.6.7orgAff1:OrganizationAffiliationcode = “HIEResponder”orgAff2:OrganizationAffiliationcode = “HIEInitiator”,“DocShare-federate-int”,“DocShare-federate-ext”orgAff3:OrganizationAffiliationcode = “HIEInitiator”,“DocShare-federate-int”,“DocShare-federate-ext”orgAff6:OrganizationAffiliationcode = “HIEResponder”:Endpointihe-specific-connection-type =XDS-Consumer-Query-AsyncResponse,XDS-Consumer-Retrieve-AsyncResponse:Endpointihe-specific-connection-type =XDS-Consumer-Query-AsyncResponse,XDS-Consumer-Retrieve-AsyncResponseparticipatingOrganizationorganizationparticipatingOrganizationorganizationparticipatingOrganizationorganizationparticipatingOrganizationorganizationparticipatingOrganizationorganizationparticipatingOrganizationorganization

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