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 2025-02-07 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C 0..* NdhOrganizationAffiliation 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 Content/Rules for all slices
.... 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
.... 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
.... 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
.... 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
..... 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
.... type SΣ 0..1 CodeableConcept Description 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.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner Σ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... active SΣ 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(Payer Provider Network Query Organization Profile) Organization where the role is available
ele-1: All FHIR elements must have a @value or children
... participatingOrganization SΣ 0..1 Reference(Payer Provider Network Query 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 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)
ele-1: All FHIR elements must have a @value or children
... code SΣ 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 SΣ 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(Payer Provider Network Query Location Profile) The location(s) at which the role occurs
ele-1: All FHIR elements must have a @value or children
... healthcareService S 0..* Reference(Payer Provider Network Query HealthcareService Profile) Healthcare services provided through the role
ele-1: All FHIR elements must have a @value or children
... telecom SΣ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... via-intermediary 0..1 Reference(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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
... endpoint S 0..* Reference(Payer Provider Network Local Directory API 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.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 .
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

This structure is derived from NdhOrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* NdhOrganizationAffiliation Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... identifier
.... type S 0..1 CodeableConcept Description of identifier
.... value S 0..1 string The value that is unique
.... assigner 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this organization affiliation record is in active use
... organization 0..1 Reference(Payer Provider Network Query Organization Profile) Organization where the role is available
... 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..* CodeableConcept Definition of the role the participatingOrganization plays
... specialty S 0..* CodeableConcept Specific 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 S 0..* Reference(Payer Provider Network Query HealthcareService Profile) Healthcare services provided through the role
... telecom S 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
.... system S 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
.... rank S 0..1 positiveInt Specify 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 C 0..* NdhOrganizationAffiliation Defines 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..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
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..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
.... logo 0..1 Attachment NDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business identifiers that are specific to this role
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this organization affiliation record is in active use
Required Pattern: true
... period SΣ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization where the role is available
... participatingOrganization SΣ 0..1 Reference(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..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣ 0..* CodeableConcept Specific 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 S 0..* Reference(Payer Provider Network Query HealthcareService Profile) Healthcare services provided through the role
... telecom SΣ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional 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..1 Reference(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ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... endpoint S 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

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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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 .
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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C 0..* NdhOrganizationAffiliation 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 Content/Rules for all slices
.... 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
.... 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
.... 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
.... 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
..... 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
.... type SΣ 0..1 CodeableConcept Description 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.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner Σ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... active SΣ 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(Payer Provider Network Query Organization Profile) Organization where the role is available
ele-1: All FHIR elements must have a @value or children
... participatingOrganization SΣ 0..1 Reference(Payer Provider Network Query 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 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)
ele-1: All FHIR elements must have a @value or children
... code SΣ 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 SΣ 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(Payer Provider Network Query Location Profile) The location(s) at which the role occurs
ele-1: All FHIR elements must have a @value or children
... healthcareService S 0..* Reference(Payer Provider Network Query HealthcareService Profile) Healthcare services provided through the role
ele-1: All FHIR elements must have a @value or children
... telecom SΣ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... contactpoint-availabletime 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... via-intermediary 0..1 Reference(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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
... endpoint S 0..* Reference(Payer Provider Network Local Directory API 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.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 .
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..* NdhOrganizationAffiliation Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... identifier
.... type S 0..1 CodeableConcept Description of identifier
.... value S 0..1 string The value that is unique
.... assigner 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this organization affiliation record is in active use
... organization 0..1 Reference(Payer Provider Network Query Organization Profile) Organization where the role is available
... 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..* CodeableConcept Definition of the role the participatingOrganization plays
... specialty S 0..* CodeableConcept Specific 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 S 0..* Reference(Payer Provider Network Query HealthcareService Profile) Healthcare services provided through the role
... telecom S 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
.... system S 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
.... rank S 0..1 positiveInt Specify 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation C 0..* NdhOrganizationAffiliation Defines 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..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
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..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
.... logo 0..1 Attachment NDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Business identifiers that are specific to this role
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this organization affiliation record is in active use
Required Pattern: true
... period SΣ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ 0..1 Reference(Payer Provider Network Query Organization Profile) Organization where the role is available
... participatingOrganization SΣ 0..1 Reference(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..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliation Roles (extensible)
... specialty SΣ 0..* CodeableConcept Specific 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 S 0..* Reference(Payer Provider Network Query HealthcareService Profile) Healthcare services provided through the role
... telecom SΣ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional 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..1 Reference(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ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... endpoint S 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

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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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 .
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