# OrganizationAffiliation

Canonical page: https://docs.ovok.com/api/fhir/r4/organization-affiliation

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/OrganizationAffiliation/[id]` |
| Vread | `GET` | `/fhir/R4/OrganizationAffiliation/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/OrganizationAffiliation/[id]` |
| Patch | `PATCH` | `/fhir/R4/OrganizationAffiliation/[id]` |
| Delete | `DELETE` | `/fhir/R4/OrganizationAffiliation/[id]` |
| Create | `POST` | `/fhir/R4/OrganizationAffiliation` |
| Search | `GET` | `/fhir/R4/OrganizationAffiliation` |
| History | `GET` | `/fhir/R4/OrganizationAffiliation/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business identifiers that are specific to this role |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this organization affiliation record is in active use |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | The period during which the participatingOrganization is affiliated with the primary organization |
| <span id="element-organization"></span>`organization` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization where the role is available |
| <span id="element-participating-organization"></span>`participatingOrganization` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization that provides/performs the role (e.g. providing services or is a member of) |
| <span id="element-network"></span>`network` | [Reference](/fhir-elements/complex/reference) | `0..*` | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Definition of the role the participatingOrganization plays |
| <span id="element-specialty"></span>`specialty` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Specific specialty of the participatingOrganization in the context of the role |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..*` | The location(s) at which the role occurs |
| <span id="element-healthcare-service"></span>`healthcareService` | [Reference](/fhir-elements/complex/reference) | `0..*` | Healthcare services provided through the role |
| <span id="element-telecom"></span>`telecom` | [ContactPoint](/fhir-elements/complex/contact-point) | `0..*` | Contact details at the participatingOrganization relevant to this Affiliation |
| <span id="element-endpoint"></span>`endpoint` | [Reference](/fhir-elements/complex/reference) | `0..*` | Technical endpoints providing access to services operated for this role |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `active` | token | Whether this organization affiliation record is in active use |
| `date` | date | The period during which the participatingOrganization is affiliated with the primary organization |
| `email` | token | A value in an email contact |
| `endpoint` | reference | Technical endpoints providing access to services operated for this role |
| `identifier` | token | An organization affiliation's Identifier |
| `location` | reference | The location(s) at which the role occurs |
| `network` | reference | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
| `participating-organization` | reference | The organization that provides services to the primary organization |
| `phone` | token | A value in a phone contact |
| `primary-organization` | reference | The organization that receives the services from the participating organization |
| `role` | token | Definition of the role the participatingOrganization plays |
| `service` | reference | Healthcare services provided through the role |
| `specialty` | token | Specific specialty of the participatingOrganization in the context of the role |
| `telecom` | token | The value in any kind of contact |

## Reference [#reference]

Official FHIR R4 spec: [OrganizationAffiliation](https://hl7.org/fhir/R4/organizationaffiliation.html).  
Maturity: Draft (FMM 0).
