OrganizationAffiliation

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

Columns

Header row
# path type required description
0 resourceType string * Resource type identifier. Must be string "OrganizationAffiliation"
1 integer * Number of subrows
2 id string * Logical id of this artifact
3 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
4 period.start dateTime Starting time with inclusive boundary
5 period.end dateTime End time with inclusive boundary, if not ongoing
organization Reference Organization where the role is available
6 organization.reference string Literal reference, Relative, internal or absolute URL
7 organization.type uri Type the reference refers to (e.g. "Patient")
organization.identifier Identifier Logical reference, when literal reference is not known
8 organization.identifier.use code usual | official | temp | secondary | old (If known)
organization.identifier.type CodeableConcept Description of identifier
organization.identifier.type.coding Coding Code defined by a terminology system
9 organization.identifier.type.coding.system uri Identity of the terminology system
10 organization.identifier.type.coding.version string Version of the system - if relevant
11 organization.identifier.type.coding.code code Symbol in syntax defined by the system
12 organization.identifier.type.coding.display string Representation defined by the system
13 organization.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
14 organization.identifier.type.text string Plain text representation of the concept
15 organization.identifier.system uri The namespace for the identifier value
16 organization.identifier.value string The value that is unique
organization.identifier.period Period Time period when id is/was valid for use
17 organization.identifier.period.start dateTime Starting time with inclusive boundary
18 organization.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
19 organization.display string Text alternative for the resource
participatingOrganization Reference Organization that provides/performs the role (e.g. providing services or is a member of)
20 participatingOrganization.reference string Literal reference, Relative, internal or absolute URL
21 participatingOrganization.type uri Type the reference refers to (e.g. "Patient")
participatingOrganization.identifier Identifier Logical reference, when literal reference is not known
22 participatingOrganization.identifier.use code usual | official | temp | secondary | old (If known)
participatingOrganization.identifier.type CodeableConcept Description of identifier
participatingOrganization.identifier.type.coding Coding Code defined by a terminology system
23 participatingOrganization.identifier.type.coding.system uri Identity of the terminology system
24 participatingOrganization.identifier.type.coding.version string Version of the system - if relevant
25 participatingOrganization.identifier.type.coding.code code Symbol in syntax defined by the system
26 participatingOrganization.identifier.type.coding.display string Representation defined by the system
27 participatingOrganization.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
28 participatingOrganization.identifier.type.text string Plain text representation of the concept
29 participatingOrganization.identifier.system uri The namespace for the identifier value
30 participatingOrganization.identifier.value string The value that is unique
participatingOrganization.identifier.period Period Time period when id is/was valid for use
31 participatingOrganization.identifier.period.start dateTime Starting time with inclusive boundary
32 participatingOrganization.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
33 participatingOrganization.display string Text alternative for the resource
Row identifier
# path type required description
0 string * Subrow identifier. Must be string "identifier"
identifier Identifier Business identifiers that are specific to this role
1 identifier.use code usual | official | temp | secondary | old (If known)
identifier.type CodeableConcept Description of identifier
identifier.type.coding Coding Code defined by a terminology system
2 identifier.type.coding.system uri Identity of the terminology system
3 identifier.type.coding.version string Version of the system - if relevant
4 identifier.type.coding.code code Symbol in syntax defined by the system
5 identifier.type.coding.display string Representation defined by the system
6 identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
7 identifier.type.text string Plain text representation of the concept
8 identifier.system uri The namespace for the identifier value
9 identifier.value string The value that is unique
identifier.period Period Time period when id is/was valid for use
10 identifier.period.start dateTime Starting time with inclusive boundary
11 identifier.period.end dateTime End time with inclusive boundary, if not ongoing
Row network
# path type required description
0 string * Subrow identifier. Must be string "network"
network Reference Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
1 network.reference string Literal reference, Relative, internal or absolute URL
2 network.type uri Type the reference refers to (e.g. "Patient")
network.identifier Identifier Logical reference, when literal reference is not known
3 network.identifier.use code usual | official | temp | secondary | old (If known)
network.identifier.type CodeableConcept Description of identifier
network.identifier.type.coding Coding Code defined by a terminology system
4 network.identifier.type.coding.system uri Identity of the terminology system
5 network.identifier.type.coding.version string Version of the system - if relevant
6 network.identifier.type.coding.code code Symbol in syntax defined by the system
7 network.identifier.type.coding.display string Representation defined by the system
8 network.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 network.identifier.type.text string Plain text representation of the concept
10 network.identifier.system uri The namespace for the identifier value
11 network.identifier.value string The value that is unique
network.identifier.period Period Time period when id is/was valid for use
12 network.identifier.period.start dateTime Starting time with inclusive boundary
13 network.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 network.display string Text alternative for the resource
Row code
# path type required description
0 string * Subrow identifier. Must be string "code"
code CodeableConcept Definition of the role the participatingOrganization plays
code.coding Coding Code defined by a terminology system
1 code.coding.system uri Identity of the terminology system
2 code.coding.version string Version of the system - if relevant
3 code.coding.code code Symbol in syntax defined by the system
4 code.coding.display string Representation defined by the system
5 code.coding.userSelected boolean If this coding was chosen directly by the user
6 code.text string Plain text representation of the concept
Row specialty
# path type required description
0 string * Subrow identifier. Must be string "specialty"
specialty CodeableConcept Specific specialty of the participatingOrganization in the context of the role
specialty.coding Coding Code defined by a terminology system
1 specialty.coding.system uri Identity of the terminology system
2 specialty.coding.version string Version of the system - if relevant
3 specialty.coding.code code Symbol in syntax defined by the system
4 specialty.coding.display string Representation defined by the system
5 specialty.coding.userSelected boolean If this coding was chosen directly by the user
6 specialty.text string Plain text representation of the concept
Row location
# path type required description
0 string * Subrow identifier. Must be string "location"
location Reference The location(s) at which the role occurs
1 location.reference string Literal reference, Relative, internal or absolute URL
2 location.type uri Type the reference refers to (e.g. "Patient")
location.identifier Identifier Logical reference, when literal reference is not known
3 location.identifier.use code usual | official | temp | secondary | old (If known)
location.identifier.type CodeableConcept Description of identifier
location.identifier.type.coding Coding Code defined by a terminology system
4 location.identifier.type.coding.system uri Identity of the terminology system
5 location.identifier.type.coding.version string Version of the system - if relevant
6 location.identifier.type.coding.code code Symbol in syntax defined by the system
7 location.identifier.type.coding.display string Representation defined by the system
8 location.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 location.identifier.type.text string Plain text representation of the concept
10 location.identifier.system uri The namespace for the identifier value
11 location.identifier.value string The value that is unique
location.identifier.period Period Time period when id is/was valid for use
12 location.identifier.period.start dateTime Starting time with inclusive boundary
13 location.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 location.display string Text alternative for the resource
Row healthcareService
# path type required description
0 string * Subrow identifier. Must be string "healthcareService"
healthcareService Reference Healthcare services provided through the role
1 healthcareService.reference string Literal reference, Relative, internal or absolute URL
2 healthcareService.type uri Type the reference refers to (e.g. "Patient")
healthcareService.identifier Identifier Logical reference, when literal reference is not known
3 healthcareService.identifier.use code usual | official | temp | secondary | old (If known)
healthcareService.identifier.type CodeableConcept Description of identifier
healthcareService.identifier.type.coding Coding Code defined by a terminology system
4 healthcareService.identifier.type.coding.system uri Identity of the terminology system
5 healthcareService.identifier.type.coding.version string Version of the system - if relevant
6 healthcareService.identifier.type.coding.code code Symbol in syntax defined by the system
7 healthcareService.identifier.type.coding.display string Representation defined by the system
8 healthcareService.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 healthcareService.identifier.type.text string Plain text representation of the concept
10 healthcareService.identifier.system uri The namespace for the identifier value
11 healthcareService.identifier.value string The value that is unique
healthcareService.identifier.period Period Time period when id is/was valid for use
12 healthcareService.identifier.period.start dateTime Starting time with inclusive boundary
13 healthcareService.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 healthcareService.display string Text alternative for the resource
Row telecom
# path type required description
0 string * Subrow identifier. Must be string "telecom"
telecom ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
1 telecom.system code phone | fax | email | pager | url | sms | other
2 telecom.value string The actual contact point details
3 telecom.use code home | work | temp | old | mobile - purpose of this contact point
4 telecom.rank positiveInt Specify preferred order of use (1 = highest)
telecom.period Period Time period when the contact point was/is in use
5 telecom.period.start dateTime Starting time with inclusive boundary
6 telecom.period.end dateTime End time with inclusive boundary, if not ongoing
Row endpoint
# path type required description
0 string * Subrow identifier. Must be string "endpoint"
endpoint Reference Technical endpoints providing access to services operated for this role
1 endpoint.reference string Literal reference, Relative, internal or absolute URL
2 endpoint.type uri Type the reference refers to (e.g. "Patient")
endpoint.identifier Identifier Logical reference, when literal reference is not known
3 endpoint.identifier.use code usual | official | temp | secondary | old (If known)
endpoint.identifier.type CodeableConcept Description of identifier
endpoint.identifier.type.coding Coding Code defined by a terminology system
4 endpoint.identifier.type.coding.system uri Identity of the terminology system
5 endpoint.identifier.type.coding.version string Version of the system - if relevant
6 endpoint.identifier.type.coding.code code Symbol in syntax defined by the system
7 endpoint.identifier.type.coding.display string Representation defined by the system
8 endpoint.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 endpoint.identifier.type.text string Plain text representation of the concept
10 endpoint.identifier.system uri The namespace for the identifier value
11 endpoint.identifier.value string The value that is unique
endpoint.identifier.period Period Time period when id is/was valid for use
12 endpoint.identifier.period.start dateTime Starting time with inclusive boundary
13 endpoint.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 endpoint.display string Text alternative for the resource

Examples

Example #1
Input CSV
OrganizationAffiliation,8,"example",true,"2012-01-01","2012-03-31","Organization/hl7pay",,,,,,,,,,,,,,"Organization/f001",,,,,,,,,,,,,
identifier,,,,,,,,"http://www.acme.org/practitioners","23",,
network,"Organization/hl7pay",,,,,,,,,,,,,"HL7 Payer Network"
code,"http://terminology.hl7.org/CodeSystem/organization-role",,"provider",,,
specialty,"http://snomed.info/sct",,"408443003","General medical practice",,
location,"Location/1",,,,,,,,,,,,,"South Wing, second floor"
healthcareService,"HealthcareService/example",,,,,,,,,,,,,
telecom,"email","general.practice@example.org","work",,,
endpoint,"Endpoint/example",,,,,,,,,,,,,
Resulting resource
{
  "resourceType": "OrganizationAffiliation",
  "id": "example",
  "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"
    }
  ]
}
Example #2
Input CSV
OrganizationAffiliation,3,"orgrole2",true,,,"http://hl7.org/fhir/ig/vhdir/Organization/monumentHIE",,,,,,,,,,,,,"Monument Health Information Exchange","http://hl7.org/fhir/ig/vhdir/Organization/foundingfathers",,,,,,,,,,,,,"Founding Fathers Memorial Hospital"
identifier,"secondary",,,,,,"member hospital","http://example.org/www.monumentHIE.com","hosp32",,
code,"http://hl7.org/fhir/organization-role",,"member","Member",,"Hospital member"
endpoint,"http://hl7.org/fhir/ig/vhdir/Endpoint/foundingfathersHIE",,,,,,,,,,,,,"Founding Fathers Memorial Hospital HIE endpoint"
Resulting resource
{
  "resourceType": "OrganizationAffiliation",
  "id": "orgrole2",
  "identifier": [
    {
      "use": "secondary",
      "type": {
        "text": "member hospital"
      },
      "system": "http://example.org/www.monumentHIE.com",
      "value": "hosp32"
    }
  ],
  "active": true,
  "organization": {
    "reference": "http://hl7.org/fhir/ig/vhdir/Organization/monumentHIE",
    "display": "Monument Health Information Exchange"
  },
  "participatingOrganization": {
    "reference": "http://hl7.org/fhir/ig/vhdir/Organization/foundingfathers",
    "display": "Founding Fathers Memorial Hospital"
  },
  "code": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/organization-role",
          "code": "member",
          "display": "Member"
        }
      ],
      "text": "Hospital member"
    }
  ],
  "endpoint": [
    {
      "reference": "http://hl7.org/fhir/ig/vhdir/Endpoint/foundingfathersHIE",
      "display": "Founding Fathers Memorial Hospital HIE endpoint"
    }
  ]
}
Example #3
Input CSV
OrganizationAffiliation,8,"orgrole1",true,"2018-02-09","2022-02-01","http://hl7.org/fhir/ig/vhdir/Organization/foundingfathers",,,,,,,,,,,,,"Founding Fathers Memorial Hospital","http://hl7.org/fhir/ig/vhdir/Organization/independencerehab",,,,,,,,,,,,,"Independence Rehabilitation Services, Inc."
identifier,"secondary",,,,,,,"http://example.org/www.foundingfathersmemorial.com","service002",,
network,"http://hl7.org/fhir/ig/vhdir/Network/patriotppo",,,,,,,,,,,,,"Patriot Preferred Provider Network"
code,"http://hl7.org/fhir/organization-role",,"provider","Provider",true,"Provider of rehabilitation services"
specialty,"http://snomed.info/sct",,"394602003","Rehabilitation - specialty",,"Rehabilitation"
location,"http://hl7.org/fhir/ig/vhdir/Location/foundingfathers1",,,,,,,,,,,,,"Founding Fathers Memorial Hospital"
healthcareService,"http://hl7.org/fhir/ig/vhdir/HealthcareService/independencerehab1",,,,,,,,,,,,,"Inpatient rehabilitation services"
healthcareService,"http://hl7.org/fhir/ig/vhdir/HealthcareService/independencerehab2",,,,,,,,,,,,,"Outpatient rehabilitation services"
telecom,"phone","202-109-8765","work",,,
Resulting resource
{
  "resourceType": "OrganizationAffiliation",
  "id": "orgrole1",
  "identifier": [
    {
      "use": "secondary",
      "system": "http://example.org/www.foundingfathersmemorial.com",
      "value": "service002"
    }
  ],
  "active": true,
  "period": {
    "start": "2018-02-09",
    "end": "2022-02-01"
  },
  "organization": {
    "reference": "http://hl7.org/fhir/ig/vhdir/Organization/foundingfathers",
    "display": "Founding Fathers Memorial Hospital"
  },
  "participatingOrganization": {
    "reference": "http://hl7.org/fhir/ig/vhdir/Organization/independencerehab",
    "display": "Independence Rehabilitation Services, Inc."
  },
  "network": [
    {
      "reference": "http://hl7.org/fhir/ig/vhdir/Network/patriotppo",
      "display": "Patriot Preferred Provider Network"
    }
  ],
  "code": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/organization-role",
          "code": "provider",
          "display": "Provider",
          "userSelected": true
        }
      ],
      "text": "Provider of rehabilitation services"
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394602003",
          "display": "Rehabilitation - specialty"
        }
      ],
      "text": "Rehabilitation"
    }
  ],
  "location": [
    {
      "reference": "http://hl7.org/fhir/ig/vhdir/Location/foundingfathers1",
      "display": "Founding Fathers Memorial Hospital"
    }
  ],
  "healthcareService": [
    {
      "reference": "http://hl7.org/fhir/ig/vhdir/HealthcareService/independencerehab1",
      "display": "Inpatient rehabilitation services"
    },
    {
      "reference": "http://hl7.org/fhir/ig/vhdir/HealthcareService/independencerehab2",
      "display": "Outpatient rehabilitation services"
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "202-109-8765",
      "use": "work"
    }
  ]
}