OrganizationAffiliation - FHIR Resource (r4)


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

Validate an OrganizationAffiliation FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether this organization affiliation record is in active use
codetrueCodeableConcept# Definition of the role the participatingOrganization plays
endpointtrueReference# Technical endpoints providing access to services operated for this role
healthcareServicetrueReference# Healthcare services provided through the role
identifiertrueIdentifier# Business identifiers that are specific to this role
locationtrueReference# The location(s) at which the role occurs
networktrueReference# Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
organizationfalseReference# Organization where the role is available
participatingOrganizationfalseReference# Organization that provides/performs the role (e.g. providing services or is a member of)
periodfalsePeriod# The period during which the participatingOrganization is affiliated with the primary organization
specialtytrueCodeableConcept# Specific specialty of the participatingOrganization in the context of the role
telecomtrueContactPoint# Contact details at the participatingOrganization relevant to this Affiliation

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 ParameterField TypeResource Fields Searched
activetextactive
datedateperiod
emailtexttelecom.where
endpointreferenceendpoint
identifiertextidentifier
locationreferencelocation
networkreferencenetwork
participating-organizationreferenceparticipatingOrganization
phonetexttelecom.where
primary-organizationreferenceorganization
roletextcode
servicereferencehealthcareService
specialtytextspecialty
telecomtexttelecom