National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot 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-ballot 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: Payer Provider Network Query OrganizationAffiliation Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPn-ldapi-OrganizationAffiliation Version: 1.0.0-ballot
Active as of 2024-03-28 Computable Name: NdhPnLdApiOrganizationAffiliation

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.

Usage:

Formal Views of Profile Content

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

This structure is derived from NdhOrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*NdhOrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... identifier
.... type S0..1CodeableConceptDescription of identifier
.... value S0..1stringThe value that is unique
.... assigner 0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... active S1..1booleanWhether this organization affiliation record is in active use
... organization 0..1Reference(Payer Provider Network Query Organization Profile)Organization where the role is available
... network S0..*Reference(Payer Provider Network Query Network Profile)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code S0..*CodeableConceptDefinition of the role the participatingOrganization plays
... specialty S0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
... location 0..*Reference(Payer Provider Network Query Location Profile)The location(s) at which the role occurs
... healthcareService S0..*Reference(Payer Provider Network Query HealthcareService Profile)Healthcare services provided through the role
... telecom S0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint 0..*Reference(Payer Provider Network Local Directory API Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*NdhOrganizationAffiliationDefines 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
... 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
... 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 .

.... type SΣ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.

.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... active SΣ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(Payer Provider Network Query Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(Payer Provider Network Query Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(Payer Provider Network Query Network Profile)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code SΣ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣ0..*Reference(Payer Provider Network Query Location Profile)The location(s) at which the role occurs
... healthcareService S0..*Reference(Payer Provider Network Query HealthcareService Profile)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... 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 SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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 SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint S0..*Reference(Payer Provider Network Local Directory API Endpoint Profile)Technical endpoints providing access to services operated for this role

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.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
http://hl7.org/fhir/us/ndh/ValueSet/OrganizationAffiliationRoleVS
from this IG
OrganizationAffiliation.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
OrganizationAffiliation.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*NdhOrganizationAffiliationDefines 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 SΣ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 SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... active SΣ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(Payer Provider Network Query Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(Payer Provider Network Query Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(Payer Provider Network Query Network Profile)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code SΣ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣ0..*Reference(Payer Provider Network Query Location Profile)The location(s) at which the role occurs
... healthcareService S0..*Reference(Payer Provider Network Query HealthcareService Profile)Healthcare services provided through the role
... telecom SΣ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 SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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 SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(Payer Provider Network Local Directory API Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
OrganizationAffiliation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
OrganizationAffiliation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
http://hl7.org/fhir/us/ndh/ValueSet/OrganizationAffiliationRoleVS
from this IG
OrganizationAffiliation.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
OrganizationAffiliation.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Differential View

This structure is derived from NdhOrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*NdhOrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... identifier
.... type S0..1CodeableConceptDescription of identifier
.... value S0..1stringThe value that is unique
.... assigner 0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... active S1..1booleanWhether this organization affiliation record is in active use
... organization 0..1Reference(Payer Provider Network Query Organization Profile)Organization where the role is available
... network S0..*Reference(Payer Provider Network Query Network Profile)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code S0..*CodeableConceptDefinition of the role the participatingOrganization plays
... specialty S0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
... location 0..*Reference(Payer Provider Network Query Location Profile)The location(s) at which the role occurs
... healthcareService S0..*Reference(Payer Provider Network Query HealthcareService Profile)Healthcare services provided through the role
... telecom S0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint 0..*Reference(Payer Provider Network Local Directory API Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*NdhOrganizationAffiliationDefines 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
... 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
... 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 .

.... type SΣ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.

.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... active SΣ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(Payer Provider Network Query Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(Payer Provider Network Query Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(Payer Provider Network Query Network Profile)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code SΣ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣ0..*Reference(Payer Provider Network Query Location Profile)The location(s) at which the role occurs
... healthcareService S0..*Reference(Payer Provider Network Query HealthcareService Profile)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... 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 SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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 SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint S0..*Reference(Payer Provider Network Local Directory API Endpoint Profile)Technical endpoints providing access to services operated for this role

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.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
http://hl7.org/fhir/us/ndh/ValueSet/OrganizationAffiliationRoleVS
from this IG
OrganizationAffiliation.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
OrganizationAffiliation.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C0..*NdhOrganizationAffiliationDefines 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 SΣ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 SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Payer Provider Network Query Organization Profile)Organization that issued id (may be just text)
... active SΣ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(Payer Provider Network Query Organization Profile)Organization where the role is available
... participatingOrganization SΣ0..1Reference(Payer Provider Network Query Organization Profile)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(Payer Provider Network Query Network Profile)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code SΣ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: Healthcare Provider Taxonomy . (extensible)
... location SΣ0..*Reference(Payer Provider Network Query Location Profile)The location(s) at which the role occurs
... healthcareService S0..*Reference(Payer Provider Network Query HealthcareService Profile)Healthcare services provided through the role
... telecom SΣ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 SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ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 SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(Payer Provider Network Local Directory API Endpoint Profile)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
OrganizationAffiliation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
OrganizationAffiliation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
http://hl7.org/fhir/us/ndh/ValueSet/OrganizationAffiliationRoleVS
from this IG
OrganizationAffiliation.specialtyextensibleHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
OrganizationAffiliation.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron