Release 4 5 Preview #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.31 8.32 Resource OrganizationAffiliation - Content

Patient Administration Work Group Maturity Level : 0   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

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

8.31.1 8.32.1 Scope and Usage

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

8.31.2 8.32.2 Boundaries and Relationships

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.

8.32.3 References

No resources refer to this resource directly.

This resource does not implement any patterns.

8.31.3 8.32.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . OrganizationAffiliation TU DomainResource Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Business identifiers that are specific to this role
. . . active Σ 0..1 boolean 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
. . . participatingOrganization Σ 0..1 Reference ( Organization ) Organization that provides/performs the role (e.g. providing services or is a member of)
. . . network Σ 0..* Reference ( Organization ) Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
. . . code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Organization Affiliation Role ( Example )
. . . specialty Σ 0..* CodeableConcept Specific 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
. . . telecom Σ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
. . . endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to services operated for this role

doco Documentation for this format

UML Diagram ( Legend )

OrganizationAffiliation ( DomainResource ) Business identifiers that are specific to this role identifier : Identifier [0..*] Whether this organization affiliation record is in active use active : boolean [0..1] The period during which the participatingOrganization is affiliated with the primary organization period : 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 » Health insurance provider 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 association code : CodeableConcept [0..*] « The role the participating organization providing services to the primary organization. (Strength=Example) OrganizationAffiliationRole ?? » Specific specialty of the participatingOrganization in the context of the role specialty : CodeableConcept [0..*] « Specific specialty associated with the participating organization. (Strength=Preferred) PracticeSettingCodeValueSet ? » The location(s) at which the role occurs location : Reference [0..*] « Location » Healthcare services provided through the role healthcareService : Reference [0..*] « HealthcareService » Contact details at the participatingOrganization relevant to this Affiliation telecom : ContactPoint [0..*] Technical endpoints providing access to services operated for this role endpoint : 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) Health insurance provider 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>
 <telecom><!-- 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation --></telecom>
 <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) }], // Health insurance provider 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
  "telecom" : [{ ContactPoint }], // 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..* Health insurance provider 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.telecom [ ContactPoint ], ... ; # 0..* 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 R3

OrganizationAffiliation
  • No Changes

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints doco
. . OrganizationAffiliation TU DomainResource Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Business identifiers that are specific to this role
. . . active Σ 0..1 boolean 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
. . . participatingOrganization Σ 0..1 Reference ( Organization ) Organization that provides/performs the role (e.g. providing services or is a member of)
. . . network Σ 0..* Reference ( Organization ) Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
. . . code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Organization Affiliation Role ( Example )
. . . specialty Σ 0..* CodeableConcept Specific 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
. . . telecom Σ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
. . . endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to services operated for this role

doco Documentation for this format

UML Diagram ( Legend )

OrganizationAffiliation ( DomainResource ) Business identifiers that are specific to this role identifier : Identifier [0..*] Whether this organization affiliation record is in active use active : boolean [0..1] The period during which the participatingOrganization is affiliated with the primary organization period : 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 » Health insurance provider 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 association code : CodeableConcept [0..*] « The role the participating organization providing services to the primary organization. (Strength=Example) OrganizationAffiliationRole ?? » Specific specialty of the participatingOrganization in the context of the role specialty : CodeableConcept [0..*] « Specific specialty associated with the participating organization. (Strength=Preferred) PracticeSettingCodeValueSet ? » The location(s) at which the role occurs location : Reference [0..*] « Location » Healthcare services provided through the role healthcareService : Reference [0..*] « HealthcareService » Contact details at the participatingOrganization relevant to this Affiliation telecom : ContactPoint [0..*] Technical endpoints providing access to services operated for this role endpoint : 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) Health insurance provider 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>
 <telecom><!-- 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation --></telecom>
 <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) }], // Health insurance provider 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
  "telecom" : [{ ContactPoint }], // 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..* Health insurance provider 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.telecom [ ContactPoint ], ... ; # 0..* 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 3

OrganizationAffiliation
  • No Changes

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a

8.31.3.1 8.32.4.1 Terminology Bindings

Path Definition Type Reference
OrganizationAffiliation.code The role the participating organization providing services to the primary organization. Example OrganizationAffiliationRole
OrganizationAffiliation.specialty Specific specialty associated with the participating organization. Preferred PracticeSettingCodeValueSet

8.31.4 8.32.5 Notes:

  • 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.

8.31.5 8.32.6 Joint Ventures

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.

8.31.6 8.32.7 Search Parameters

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

Name Type Description Expression In Common
active N token Whether this organization affiliation record is in active use OrganizationAffiliation.active
date date The period during which the participatingOrganization is affiliated with the primary organization OrganizationAffiliation.period
email token A value in an email contact OrganizationAffiliation.telecom.where(system='email')
endpoint reference Technical endpoints providing access to services operated for this role OrganizationAffiliation.endpoint
( Endpoint )
identifier token An organization affiliation's Identifier OrganizationAffiliation.identifier
location reference The location(s) at which the role occurs OrganizationAffiliation.location
( Location )
network reference Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) OrganizationAffiliation.network
( Organization )
participating-organization reference The organization that provides services to the primary organization OrganizationAffiliation.participatingOrganization
( Organization )
phone token A value in a phone contact OrganizationAffiliation.telecom.where(system='phone')
primary-organization reference The organization that receives the services from the participating organization OrganizationAffiliation.organization
( Organization )
role token Definition of the role the participatingOrganization plays OrganizationAffiliation.code
service reference Healthcare services provided through the role OrganizationAffiliation.healthcareService
( HealthcareService )
specialty token Specific specialty of the participatingOrganization in the context of the role OrganizationAffiliation.specialty
telecom token The value in any kind of contact OrganizationAffiliation.telecom