The OrganizationAffiliation resource implements the FHIR R4 OrganizationAffiliation specification

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Business identifiers that are specific to this role
active boolean 0..1   Whether this organization affiliation record is in active use
period Period 0..1   The period during which the participatingOrganization is affiliated with the primary organization
organization Reference(Organization) 0..1   Organization where the role is available
participatingOrganization Reference(Organization) 0..1   Organization that provides/performs the role (e.g. providing services or is a member of)
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)
code CodeableConcept 0..*   Definition of the role the participatingOrganization plays Organization Affiliation Role ( Example )
specialty CodeableConcept 0..*   Specific specialty of the participatingOrganization in the context of the role Practice Setting Code Value Set ( Preferred )
location Reference(Location) 0..*   The location(s) at which the role occurs
healthcareService Reference(HealthcareService) 0..*   Healthcare services provided through the role
telecom ContactPoint 0..*   Contact details at the participatingOrganization relevant to this Affiliation
endpoint Reference(Endpoint) 0..*   Technical endpoints providing access to services operated for this role
OrganizationAffiliation DomainResource     Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationshipElements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier Identifier 0..*   Business identifiers that are specific to this role
active boolean 0..1   Whether this organization affiliation record is in active use
period Period 0..1   The period during which the participatingOrganization is affiliated with the primary organization
organization Reference(Organization) 0..1   Organization where the role is available
participatingOrganization Reference(Organization) 0..1   Organization that provides/performs the role (e.g. providing services or is a member of)
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)
code CodeableConcept 0..*   Definition of the role the participatingOrganization plays Organization Affiliation Role ( Example )
specialty CodeableConcept 0..*   Specific specialty of the participatingOrganization in the context of the role Practice Setting Code Value Set ( Preferred )
location Reference(Location) 0..*   The location(s) at which the role occurs
healthcareService Reference(HealthcareService) 0..*   Healthcare services provided through the role
telecom ContactPoint 0..*   Contact details at the participatingOrganization relevant to this Affiliation
endpoint Reference(Endpoint) 0..*   Technical endpoints providing access to services operated for this role

Interactions

Read

Get a OrganizationAffiliation entry by id

GET /OrganizationAffiliation/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/OrganizationAffiliation/f3775587-196a-462d-8633-cd50c21d0611

Response

{
  "resourceType": "OrganizationAffiliation",
  "id": "f3775587-196a-462d-8633-cd50c21d0611",
  "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/000003e8-4600-21f0-8b00-325096b39f47"
  },
  "participatingOrganization": {
    "reference": "Organization/31199498-4600-11f0-b8e2-325096b39f47"
  },
  "network": [
    {
      "reference": "Organization/3119911e-4600-11f0-b531-325096b39f47",
      "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/31199b50-4600-11f0-b699-325096b39f47",
      "display": "South Wing, second floor"
    }
  ],
  "healthcareService": [
    {
      "reference": "HealthcareService/31199b50-4600-11f0-b699-325096b39f47"
    }
  ],
  "telecom": [
    {
      "system": "email",
      "value": "general.practice@example.org",
      "use": "work"
    }
  ],
  "endpoint": [
    {
      "reference": "Endpoint/790850ff-d245-4767-b6c4-749e620b328c"
    }
  ]
}

Query OrganizationAffiliation resources

GET /OrganizationAffiliation?:query_parameters

Parameters

Name Type Description
identifier token An organization affiliation’s Identifier
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
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

Errors

Code Description
400 Invalid parameters
404 Resource not found