National Healthcare Directory Exchange
1.0.0-ballot - ballot US

This page is part of the National Healthcare Directory Exchange (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: National Directory OrganizationAffiliation

Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-OrganizationAffiliation Version: 1.0.0-ballot
Active as of 2022-08-09 Computable Name: NatlDirExOrganizationAffiliation

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 NatlDirEndpointQryOrganizationAffiliation

Summary

Must-Support: 2 elements

This structure is derived from NatlDirEndpointQryOrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*NatlDirEndpointQryOrganizationAffiliationDefines 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*NatlDirEndpointQryOrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... id Σ0..1stringLogical 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
... extension 0..*ExtensionAdditional content defined by implementations
... 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
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 SΣ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period Σ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network Σ0..*Reference(National Directory Endpoint Qry Exchange Network)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 (required)
... location SΣ0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which the role occurs
... healthcareService 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)Healthcare services provided through the role
... telecom Σ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*NatlDirEndpointQryOrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... identifier Σ0..*IdentifierBusiness identifiers that are specific to this role
.... 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.

.... value Σ0..1stringThe value that is unique
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... organization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the role is available
... participatingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... endpoint 0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

This structure is derived from NatlDirEndpointQryOrganizationAffiliation

Summary

Must-Support: 2 elements

Differential View

This structure is derived from NatlDirEndpointQryOrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*NatlDirEndpointQryOrganizationAffiliationDefines 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*NatlDirEndpointQryOrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... id Σ0..1stringLogical 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
... extension 0..*ExtensionAdditional content defined by implementations
... 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
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 SΣ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this organization affiliation record is in active use
Required Pattern: true
... period Σ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network Σ0..*Reference(National Directory Endpoint Qry Exchange Network)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 (required)
... location SΣ0..*Reference(National Directory Endpoint Qry Exchange Location)The location(s) at which the role occurs
... healthcareService 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)Healthcare services provided through the role
... telecom Σ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.meta.securityextensibleAll Security Labels
OrganizationAffiliation.meta.tagexampleCommonTags
OrganizationAffiliation.languagepreferredCommonLanguages
Max Binding: AllLanguages
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeextensibleOrganizationAffiliationRoleVS
OrganizationAffiliation.specialtyrequiredSpecialtiesVS