FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.32 Resource OrganizationAffiliation - Content

Patient Administration icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Defines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.

A relationship between 2 organizations over a period of time, where the entities are separate business entities. The relationship can optionally include details of locations/services from the participating organization.

The OrganizationAffiliation enables defining non-hierarchical relationships between organizations. For example:

  • One organization may provide services to another organization
    e.g. An agency service providing casual staff, a radiology service, a diagnostic lab, catering services, community care services etc.
  • Two or more organizations may form a partnership or joint venture
  • An organization may be a member of an association, 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

The Organization.partOf is used to form a hierarchical relationships within an organization which eventually resolves to a single organization. Each child in the tree is a subdivision of the parent.
The OrganizationAffiliation is used to describe the relationship between two distinct organizations. It does not require a hierarchical relationship. A resource instance is for a singular linkage between 2 organizations (it does not contain all members), to create multiple affiliations, create additional resources for the other relationship between other organizations.
Each instance contains its own period, and optionally links to specific related services/locations that are available. These referenced locations/services should be associated with the participating organization, and are available to the primary organization.

This resource should not be used when the affiliates are part of a single organization.

No references for this Resource.

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. OrganizationAffiliation TUDomainResourceDefines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifiers that are specific to this role

... active Σ0..1booleanWhether this organization affiliation record is in active use
... period Σ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... participatingOrganization Σ0..1Reference(Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network Σ0..*Reference(Organization)The 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
Organization Affiliation Role (Example)

... specialty Σ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Practice Setting Code Value Set (Preferred)

... location Σ0..*Reference(Location)The location(s) at which the role occurs

... healthcareService 0..*Reference(HealthcareService)Healthcare services provided through the role

... contact C0..*ExtendedContactDetailOfficial contact details at the participatingOrganization relevant to this Affiliation
+ Rule: The telecom of an organization can never be of use 'home'
+ Rule: The address of an organization can never be of use 'home'

... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for this role


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

OrganizationAffiliation (DomainResource)Business identifiers that are specific to this roleidentifier : Identifier [0..*]Whether this organization affiliation record is in active useactive : boolean [0..1]The period during which the participatingOrganization is affiliated with the primary organizationperiod : Period [0..1]Organization where the role is available (primary organization/has members)organization : Reference [0..1] « Organization »The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of)participatingOrganization : Reference [0..1] « Organization »The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)network : Reference [0..*] « Organization »Definition of the role the participatingOrganization plays in the associationcode : CodeableConcept [0..*] « null (Strength=Example)OrganizationAffiliationRole?? »Specific specialty of the participatingOrganization in the context of the rolespecialty : CodeableConcept [0..*] « null (Strength=Preferred)PracticeSettingCodeValueSet? »The location(s) at which the role occurslocation : Reference [0..*] « Location »Healthcare services provided through the rolehealthcareService : Reference [0..*] « HealthcareService »The contact details of communication devices available at the participatingOrganization relevant to this Affiliationcontact : ExtendedContactDetail [0..*]Technical endpoints providing access to services operated for this roleendpoint : Reference [0..*] « Endpoint »

XML Template

<OrganizationAffiliation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifiers that are specific to this role --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this organization affiliation record is in active use -->
 <period><!-- 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization --></period>
 <organization><!-- 0..1 Reference(Organization) Organization where the role is available --></organization>
 <participatingOrganization><!-- 0..1 Reference(Organization) Organization that provides/performs the role (e.g. providing services or is a member of) --></participatingOrganization>
 <network><!-- 0..* Reference(Organization) The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) --></network>
 <code><!-- 0..* CodeableConcept Definition of the role the participatingOrganization plays --></code>
 <specialty><!-- 0..* CodeableConcept Specific specialty of the participatingOrganization in the context of the role --></specialty>
 <location><!-- 0..* Reference(Location) The location(s) at which the role occurs --></location>
 <healthcareService><!-- 0..* Reference(HealthcareService) Healthcare services provided through the role --></healthcareService>
 <contact><!-- 0..* ExtendedContactDetail Official contact details at the participatingOrganization relevant to this Affiliation --></contact>
 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for this role --></endpoint>
</OrganizationAffiliation>

JSON Template

{doco
  "resourceType" : "OrganizationAffiliation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifiers that are specific to this role
  "active" : <boolean>, // Whether this organization affiliation record is in active use
  "period" : { Period }, // The period during which the participatingOrganization is affiliated with the primary organization
  "organization" : { Reference(Organization) }, // Organization where the role is available
  "participatingOrganization" : { Reference(Organization) }, // Organization that provides/performs the role (e.g. providing services or is a member of)
  "network" : [{ Reference(Organization) }], // The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
  "code" : [{ CodeableConcept }], // Definition of the role the participatingOrganization plays
  "specialty" : [{ CodeableConcept }], // Specific specialty of the participatingOrganization in the context of the role
  "location" : [{ Reference(Location) }], // The location(s) at which the role occurs
  "healthcareService" : [{ Reference(HealthcareService) }], // Healthcare services provided through the role
  "contact" : [{ ExtendedContactDetail }], // Official contact details at the participatingOrganization relevant to this Affiliation
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for this role
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:OrganizationAffiliation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:OrganizationAffiliation.identifier [ Identifier ], ... ; # 0..* Business identifiers that are specific to this role
  fhir:OrganizationAffiliation.active [ boolean ]; # 0..1 Whether this organization affiliation record is in active use
  fhir:OrganizationAffiliation.period [ Period ]; # 0..1 The period during which the participatingOrganization is affiliated with the primary organization
  fhir:OrganizationAffiliation.organization [ Reference(Organization) ]; # 0..1 Organization where the role is available
  fhir:OrganizationAffiliation.participatingOrganization [ Reference(Organization) ]; # 0..1 Organization that provides/performs the role (e.g. providing services or is a member of)
  fhir:OrganizationAffiliation.network [ Reference(Organization) ], ... ; # 0..* The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
  fhir:OrganizationAffiliation.code [ CodeableConcept ], ... ; # 0..* Definition of the role the participatingOrganization plays
  fhir:OrganizationAffiliation.specialty [ CodeableConcept ], ... ; # 0..* Specific specialty of the participatingOrganization in the context of the role
  fhir:OrganizationAffiliation.location [ Reference(Location) ], ... ; # 0..* The location(s) at which the role occurs
  fhir:OrganizationAffiliation.healthcareService [ Reference(HealthcareService) ], ... ; # 0..* Healthcare services provided through the role
  fhir:OrganizationAffiliation.contact [ ExtendedContactDetail ], ... ; # 0..* Official contact details at the participatingOrganization relevant to this Affiliation
  fhir:OrganizationAffiliation.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for this role
]

Changes since R4

OrganizationAffiliation
OrganizationAffiliation.contact
  • Added Element
OrganizationAffiliation.telecom
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. OrganizationAffiliation TUDomainResourceDefines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifiers that are specific to this role

... active Σ0..1booleanWhether this organization affiliation record is in active use
... period Σ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... participatingOrganization Σ0..1Reference(Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network Σ0..*Reference(Organization)The 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
Organization Affiliation Role (Example)

... specialty Σ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Practice Setting Code Value Set (Preferred)

... location Σ0..*Reference(Location)The location(s) at which the role occurs

... healthcareService 0..*Reference(HealthcareService)Healthcare services provided through the role

... contact C0..*ExtendedContactDetailOfficial contact details at the participatingOrganization relevant to this Affiliation
+ Rule: The telecom of an organization can never be of use 'home'
+ Rule: The address of an organization can never be of use 'home'

... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for this role


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

OrganizationAffiliation (DomainResource)Business identifiers that are specific to this roleidentifier : Identifier [0..*]Whether this organization affiliation record is in active useactive : boolean [0..1]The period during which the participatingOrganization is affiliated with the primary organizationperiod : Period [0..1]Organization where the role is available (primary organization/has members)organization : Reference [0..1] « Organization »The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of)participatingOrganization : Reference [0..1] « Organization »The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)network : Reference [0..*] « Organization »Definition of the role the participatingOrganization plays in the associationcode : CodeableConcept [0..*] « null (Strength=Example)OrganizationAffiliationRole?? »Specific specialty of the participatingOrganization in the context of the rolespecialty : CodeableConcept [0..*] « null (Strength=Preferred)PracticeSettingCodeValueSet? »The location(s) at which the role occurslocation : Reference [0..*] « Location »Healthcare services provided through the rolehealthcareService : Reference [0..*] « HealthcareService »The contact details of communication devices available at the participatingOrganization relevant to this Affiliationcontact : ExtendedContactDetail [0..*]Technical endpoints providing access to services operated for this roleendpoint : Reference [0..*] « Endpoint »

XML Template

<OrganizationAffiliation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifiers that are specific to this role --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this organization affiliation record is in active use -->
 <period><!-- 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization --></period>
 <organization><!-- 0..1 Reference(Organization) Organization where the role is available --></organization>
 <participatingOrganization><!-- 0..1 Reference(Organization) Organization that provides/performs the role (e.g. providing services or is a member of) --></participatingOrganization>
 <network><!-- 0..* Reference(Organization) The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) --></network>
 <code><!-- 0..* CodeableConcept Definition of the role the participatingOrganization plays --></code>
 <specialty><!-- 0..* CodeableConcept Specific specialty of the participatingOrganization in the context of the role --></specialty>
 <location><!-- 0..* Reference(Location) The location(s) at which the role occurs --></location>
 <healthcareService><!-- 0..* Reference(HealthcareService) Healthcare services provided through the role --></healthcareService>
 <contact><!-- 0..* ExtendedContactDetail Official contact details at the participatingOrganization relevant to this Affiliation --></contact>
 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for this role --></endpoint>
</OrganizationAffiliation>

JSON Template

{doco
  "resourceType" : "OrganizationAffiliation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifiers that are specific to this role
  "active" : <boolean>, // Whether this organization affiliation record is in active use
  "period" : { Period }, // The period during which the participatingOrganization is affiliated with the primary organization
  "organization" : { Reference(Organization) }, // Organization where the role is available
  "participatingOrganization" : { Reference(Organization) }, // Organization that provides/performs the role (e.g. providing services or is a member of)
  "network" : [{ Reference(Organization) }], // The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
  "code" : [{ CodeableConcept }], // Definition of the role the participatingOrganization plays
  "specialty" : [{ CodeableConcept }], // Specific specialty of the participatingOrganization in the context of the role
  "location" : [{ Reference(Location) }], // The location(s) at which the role occurs
  "healthcareService" : [{ Reference(HealthcareService) }], // Healthcare services provided through the role
  "contact" : [{ ExtendedContactDetail }], // Official contact details at the participatingOrganization relevant to this Affiliation
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for this role
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:OrganizationAffiliation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:OrganizationAffiliation.identifier [ Identifier ], ... ; # 0..* Business identifiers that are specific to this role
  fhir:OrganizationAffiliation.active [ boolean ]; # 0..1 Whether this organization affiliation record is in active use
  fhir:OrganizationAffiliation.period [ Period ]; # 0..1 The period during which the participatingOrganization is affiliated with the primary organization
  fhir:OrganizationAffiliation.organization [ Reference(Organization) ]; # 0..1 Organization where the role is available
  fhir:OrganizationAffiliation.participatingOrganization [ Reference(Organization) ]; # 0..1 Organization that provides/performs the role (e.g. providing services or is a member of)
  fhir:OrganizationAffiliation.network [ Reference(Organization) ], ... ; # 0..* The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
  fhir:OrganizationAffiliation.code [ CodeableConcept ], ... ; # 0..* Definition of the role the participatingOrganization plays
  fhir:OrganizationAffiliation.specialty [ CodeableConcept ], ... ; # 0..* Specific specialty of the participatingOrganization in the context of the role
  fhir:OrganizationAffiliation.location [ Reference(Location) ], ... ; # 0..* The location(s) at which the role occurs
  fhir:OrganizationAffiliation.healthcareService [ Reference(HealthcareService) ], ... ; # 0..* Healthcare services provided through the role
  fhir:OrganizationAffiliation.contact [ ExtendedContactDetail ], ... ; # 0..* Official contact details at the participatingOrganization relevant to this Affiliation
  fhir:OrganizationAffiliation.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for this role
]

Changes since Release 4

OrganizationAffiliation
OrganizationAffiliation.contact
  • Added Element
OrganizationAffiliation.telecom
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

PathDefinitionTypeReference
OrganizationAffiliation.code

This example value set defines a set of codes that can be used to indicate the role of one Organization in relation to another.

ExampleOrganizationAffiliationRole
OrganizationAffiliation.specialty

This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.

PreferredPracticeSettingCodeValueSet

UniqueKeyLevelLocationDescriptionExpression
img org-3Rule OrganizationAffiliation.contactThe telecom of an organization can never be of use 'home'telecom.where(use = 'home').empty()
img org-4Rule OrganizationAffiliation.contactThe address of an organization can never be of use 'home'address.where(use = 'home').empty()

  • Multiple instances of an OrganizationAffilitiation may exist between the same 2 organizations if a specific combination of the other related properties is required, or has a different period of usage.
    Some systems record a collection of service values for a single location, others record the single service and the list of locations it is available. Both are acceptable options for representing this data.
  • If the HealthcareService contains more locations than specified in the Affilition, then only those in the Affiliation are relevant in the OrganizationAffiliation, it cannot introduce new locations not covered by the HealthcareService.
    Conversely if no Locations are specified, then it can be assumed that all locations are available.
  • For some types of affiliation the HealthcareService might not be relevant and be empty, and location could be included.

With a joint venture between multiple organizations, a seperate Organization is created which represents the Venture. Each Organization in the venture is created through a seperate OrganizationAffiliation resource with the telecom details provided in each being the contact point to call for enquiries relating to their affiliation in the venture.

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
active NtokenWhether this organization affiliation record is in active useOrganizationAffiliation.active
datedateThe period during which the participatingOrganization is affiliated with the primary organizationOrganizationAffiliation.period
emailtokenA value in an email contactOrganizationAffiliation.contact.telecom.where(system='email')
endpointreferenceTechnical endpoints providing access to services operated for this roleOrganizationAffiliation.endpoint
(Endpoint)
identifiertokenAn organization affiliation's IdentifierOrganizationAffiliation.identifier
locationreferenceThe location(s) at which the role occursOrganizationAffiliation.location
(Location)
networkreferenceHealth insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)OrganizationAffiliation.network
(Organization)
participating-organizationreferenceThe organization that provides services to the primary organizationOrganizationAffiliation.participatingOrganization
(Organization)
phonetokenA value in a phone contactOrganizationAffiliation.contact.telecom.where(system='phone')
primary-organizationreferenceThe organization that receives the services from the participating organizationOrganizationAffiliation.organization
(Organization)
roletokenDefinition of the role the participatingOrganization playsOrganizationAffiliation.code
servicereferenceHealthcare services provided through the roleOrganizationAffiliation.healthcareService
(HealthcareService)
specialtytokenSpecific specialty of the participatingOrganization in the context of the roleOrganizationAffiliation.specialty
telecomtokenThe value in any kind of contactOrganizationAffiliation.contact.telecom