Validated Healthcare Directory
0.2.0 - CI Build United States of America flag

Validated Healthcare Directory, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions

Resource Profile: VhDir Organization Affiliation

Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organizationaffiliation Version: 0.2.0
Active as of 2017-12-08 Computable Name: VhdirOrganizationAffiliation

Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License

Details about the role a participating organization plays in relation to a primary organization

This profile sets minimum expectations for searching for and fetching information associated with an organization role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the OrganizationAffiliation resource when using this profile.

Background & Scope

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.

OrganizationAffiliation addresses the need to define a non-hierarchical relationship between two or more organizations. For example:

  • One organization may provide services to another organization
  • Two or more organizations may form a partnership or joint venture
  • An organization may be a member of another organization, but not owned by it (e.g. a hospital is a member the American Hospital Association, a hospital is a member of a health information exchange network)

OrganizationAffiliation is similar in structure to practitionerRole. Instead of references to practitioner and organization (as in practitionerRole), organizationaffiliation includes references to a participatingOrg and an organization. The participating organization provides “services” to the primary organization (much like a practitioner provides services to an organization). Using the three examples above:

  • The participating organization provides services to the primary organization
  • The joint venture is considered the primary organization, and partners within the joint venture are considered participating organizations (requires two organizationaffiliation resource instances)
  • An association is the primary organization, and its members are participating organizations.

OrganizationAffiliation is also used to indicate when an organization provides services for a health insurance provider network.

–

This profile modifies the base OrganizationAffiliation resource in the following manner:

  • Constrains the cardinality of OrganizationAffiliation.active (1..1), OrganizationAffiliation.telecom.system (1..1), and OrganizationAffiliation.telecom.value (1..1)

  • All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

  • Adds extensions:

  1. Identifier status (1..1) - indicates the status of an identifier for the role
  2. Via intermediary (0..1) - a reference to an alternative point of contact for this role
  3. Available time (0..*) - indicates when the point of contact for this role is available
  4. Restriction (0..*) - indicates whether disclosure of any data associated with this role is restricted

Examples:

The following are example uses for the vhdir-organizationaffiliation profile:

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each OrganizationAffiliation must have:

  1. A boolean value in OrganizationAffiliation.active

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 0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier S0..*IdentifierBusiness identifiers that are specific to this role
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active S1..1booleanWhether this organization affiliation record is in active use
... period S0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization S0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization S0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network S0..*Reference(VhDir Network)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 S0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)Healthcare services provided through the role
... telecom S0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ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 SΣ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 SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(VhDir Network)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: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization.


... location SΣ0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ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 SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... 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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ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 SΣ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 SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(VhDir Network)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: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization.


... location SΣ0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ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 SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

Differential View

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier S0..*IdentifierBusiness identifiers that are specific to this role
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... period S0..1PeriodTime period when id is/was valid for use
.... assigner S0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active S1..1booleanWhether this organization affiliation record is in active use
... period S0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization S0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization S0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network S0..*Reference(VhDir Network)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 S0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)Healthcare services provided through the role
... telecom S0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
.... period S0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ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 SΣ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 SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(VhDir Network)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: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization.


... location SΣ0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ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 SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*OrganizationAffiliationDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... 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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ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 SΣ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 SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(VhDir Network)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: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization.


... location SΣ0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ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 SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
OrganizationAffiliation.identifier.userequiredIdentifierUse
OrganizationAffiliation.identifier.typeextensibleIdentifier Type Codes
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
OrganizationAffiliation.telecom.systemrequiredContactPointSystem
OrganizationAffiliation.telecom.userequiredContactPointUse

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Searches

  1. GET [base]/OrganizationAffiliation?active=[code]

    Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-active

  1. GET [base]/OrganizationAffiliation?endpoint=[id]

    Support: SHOULD support search by the endpoint parameter

    • with a target type: Endpoint
    • including these search paramaters which may be chained: endpoint.identifier, endpoint.connection-type, endpoint.organization

  1. GET [base]/OrganizationAffiliation?identifier=[code]

    Support: SHALL support search by the identifier parameter

    • including the modifiers: text, ofType

  1. GET [base]/Organization?identifier-assigner=[id]

    Support: MAY support search by the identifier-assigner parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: identifier-assigner.identifier, identifier-assigner.name

  1. GET [base]/OrganizationAffiliation?location=[id]

    Support: SHALL support search by the location parameter

    • with a target type: Location
    • including the modifiers: above, below
    • including these search paramaters which may be chained: location.identifier, location.type, location.address, location.organization

  1. GET [base]/OrganizationAffiliation?network=[id]

    Support: SHOULD support search by the network parameter

    • with a target type: Organization
    • including these search paramaters which may be chained: network.identifier, network.name, network.partof

  1. GET [base]/OrganizationAffiliation?participating-organization=[id]

    Support: SHALL support search by the participating-organization parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: participating-organization.identifier, participating-organization.name, participating-organization.address, participating-organization.partof, participating-organization.type

  1. GET [base]/OrganizationAffiliation?primary-organization=[id]

    Support: SHALL support search by the primary-organization parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: primary-organization.identifier, primary-organization.type, primary-organization.address, primary-organization.name, primary-organization.partof

  1. GET [base]/OrganizationAffiliation?role=[code]

    Support: SHALL support search by the role parameter

    • including the modifiers: text

  1. GET [base]/OrganizationAffiliation?service=[id]

    Support: SHOULD support search by the service parameter

    • with a target type: HealthcareService
    • including these search paramaters which may be chained: service.identifier, service.service-category, service.organization, service.location

  1. GET [base]/OrganizationAffiliation?specialty=[code]

    Support: SHOULD support search by the specialty parameter

    • including the modifiers: text

  1. GET [base]/Organization?via-intermediary=[id]

    Support: MAY support search by the via-intermediary parameter

    • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location