OrganizationAffiliation - FHIR Resource (r4)

This OrganizationAffiliation Resource uses the FHIR API standard for access and structure.

Validate an OrganizationAffiliation FHIR Resource (r4)

OrganizationAffiliation Attributes

AttributeField is listTypeDescription

Description: Business identifiers that are specific to this role

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://www.acme.org/practitioners",
    "value": "23"
  }
]

Learn more about the (OrganizationAffiliation) identifier FHIR attribute

Description: Whether this organization affiliation record is in active use

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"active": true

Learn more about the (OrganizationAffiliation) active FHIR attribute

Description: The period during which the participatingOrganization is affiliated with the primary organization

FHIR Version: r4

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"period": {
  "start": "2012-01-01",
  "end": "2012-03-31"
}

Learn more about the (OrganizationAffiliation) period FHIR attribute

Description: Organization where the role is available

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"organization": {
  "reference": "Organization/hl7pay"
}

Learn more about the (OrganizationAffiliation) organization FHIR attribute

Description: Organization that provides/performs the role (e.g. providing services or is a member of)

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"participatingOrganization": {
  "reference": "Organization/f001"
}

Learn more about the (OrganizationAffiliation) participatingOrganization FHIR attribute

Description: Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"network": [
  {
    "reference": "Organization/hl7pay",
    "display": "HL7 Payer Network"
  }
]

Learn more about the (OrganizationAffiliation) network FHIR attribute

Description: Definition of the role the participatingOrganization plays

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": [
  {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/organization-role",
        "code": "provider"
      }
    ]
  }
]

Learn more about the (OrganizationAffiliation) code FHIR attribute

Description: Specific specialty of the participatingOrganization in the context of the role

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"specialty": [
  {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "408443003",
        "display": "General medical practice"
      }
    ]
  }
]

Learn more about the (OrganizationAffiliation) specialty FHIR attribute

Description: The location(s) at which the role occurs

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"location": [
  {
    "reference": "Location/1",
    "display": "South Wing, second floor"
  }
]

Learn more about the (OrganizationAffiliation) location FHIR attribute

Description: Healthcare services provided through the role

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"healthcareService": [
  {
    "reference": "HealthcareService/example"
  }
]

Learn more about the (OrganizationAffiliation) healthcareService FHIR attribute

Description: Contact details at the participatingOrganization relevant to this Affiliation

FHIR Version: r4

Attribute Type : ContactPoint

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"telecom": [
  {
    "system": "email",
    "value": "general.practice@example.org",
    "use": "work"
  }
]

Learn more about the (OrganizationAffiliation) telecom FHIR attribute

Description: Technical endpoints providing access to services operated for this role

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"endpoint": [
  {
    "reference": "Endpoint/example"
  }
]

Learn more about the (OrganizationAffiliation) endpoint FHIR attribute

OrganizationAffiliation Example

{
  "resourceType": "OrganizationAffiliation",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>\n\t\t\t\tHL7 Payer Network services for Acme Hospital from 1-Jan 2012 to 31-Mar 2012\n\t\t\t</p>\n\t\t</div>"
  },
  "identifier": [
    {
      "system": "http://www.acme.org/practitioners",
      "value": "23"
    }
  ],
  "active": true,
  "period": {
    "start": "2012-01-01",
    "end": "2012-03-31"
  },
  "organization": {
    "reference": "Organization/hl7pay"
  },
  "participatingOrganization": {
    "reference": "Organization/f001"
  },
  "network": [
    {
      "reference": "Organization/hl7pay",
      "display": "HL7 Payer Network"
    }
  ],
  "code": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/organization-role",
          "code": "provider"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "408443003",
          "display": "General medical practice"
        }
      ]
    }
  ],
  "location": [
    {
      "reference": "Location/1",
      "display": "South Wing, second floor"
    }
  ],
  "healthcareService": [
    {
      "reference": "HealthcareService/example"
    }
  ],
  "telecom": [
    {
      "system": "email",
      "value": "general.practice@example.org",
      "use": "work"
    }
  ],
  "endpoint": [
    {
      "reference": "Endpoint/example"
    }
  ]
}

OrganizationAffiliation Structure

{
  "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
}

OrganizationAffiliation Search Parameters

The following search parameters can be used to query OrganizationAffiliation resources. Just submit them like so:

https://api.1up.health/fhir/r4/OrganizationAffiliation?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`active`	`text`	`active`
`date`	`date`	`period`
`email`	`text`	`telecom.where`
`endpoint`	`reference`	`endpoint`
`identifier`	`text`	`identifier`
`location`	`reference`	`location`
`network`	`reference`	`network`
`participating-organization`	`reference`	`participatingOrganization`
`phone`	`text`	`telecom.where`
`primary-organization`	`reference`	`organization`
`role`	`text`	`code`
`service`	`reference`	`healthcareService`
`specialty`	`text`	`specialty`
`telecom`	`text`	`telecom`