VhDir Implementation Guide CI Build

This is the Continuous Integration Build of the VhDir Implementation Guide, based on FHIR Version 4.0.0. See the Directory of published versions

StructureDefinition-vhdir-organizationaffiliation

This profile sets minimum expectations for searching for and fetching information associated with an organization role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the OrganizationAffiliation resource when using this profile.

Background & Scope

The OrganizationAffiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information.

OrganizationAffiliation addresses the need to define a non-hierarchical relationship between two or more organizations. For example:

  • One organization may provide services to another organization
  • Two or more organizations may form a partnership or joint venture
  • An organization may be a member of another organization, but not owned by it (e.g. a hospital is a member the American Hospital Association, a hospital is a member of a health information exchange network)

OrganizationAffiliation is similar in structure to practitionerRole. Instead of references to practitioner and organization (as in practitionerRole), organizationaffiliation includes references to a participatingOrg and an organization. The participating organization provides “services” to the primary organization (much like a practitioner provides services to an organization). Using the three examples above:

  • The participating organization provides services to the primary organization
  • The joint venture is considered the primary organization, and partners within the joint venture are considered participating organizations (requires two organizationaffiliation resource instances)
  • An association is the primary organization, and its members are participating organizations.

OrganizationAffiliation is also used to indicate when an organization provides services for a health insurance provider network.

This profile modifies the base OrganizationAffiliation resource in the following manner:

  • Constrains the cardinality of OrganizationAffiliation.active (1..1), OrganizationAffiliation.telecom.system (1..1), and OrganizationAffiliation.telecom.value (1..1)

  • All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

  • Adds extensions:

  1. Identifier status (1..1) - indicates the status of an identifier for the role
  2. Via intermediary (0..1) - a reference to an alternative point of contact for this role
  3. Available time (0..*) - indicates when the point of contact for this role is available
  4. Restriction (0..*) - indicates whether disclosure of any data associated with this role is restricted

Examples:

The following are example uses for the vhdir-organizationaffiliation profile:

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each OrganizationAffiliation must have:

  1. A boolean value in OrganizationAffiliation.active

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organizationaffiliation

Published on Fri Dec 08 20:32:24 UTC 2017 as a active by .

This profile builds on OrganizationAffiliation


NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier S0..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
.... use S0..1code
.... type S0..1CodeableConcept
.... system S0..1uri
.... value S0..1string
.... period S0..1Period
.... assigner S0..1Reference(VhDir Organization)
... active S1..1boolean
... period S0..1Period
... organization S0..1Reference(VhDir Organization)
... participatingOrganization S0..1Reference(VhDir Organization)
... network S0..*Reference(VhDir Network)
... code S0..*CodeableConcept
... specialty S0..*CodeableConcept
... location S0..*Reference(VhDir Location)
... healthcareService S0..*Reference(VhDir Healthcare Service)
... telecom S0..*ContactPoint
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system S1..1code
.... value S1..1string
.... use S0..1code
.... rank S0..1positiveInt
.... period S0..1Period
... endpoint S0..*Reference(VhDir Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode S1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General': 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(VhDir Network)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code SΣ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred)
... location SΣ0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension S0..*ExtensionDays of week
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"daysOfWeek"
...... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
..... extension S0..1ExtensionAll day
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension S0..1ExtensionAvailable start time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension S0..1ExtensionAvailable end time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableEndTime"
...... valueTime 1..1timeAvailable end time
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
..... valueReference S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... identifier S0..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
.... use S0..1code
.... type S0..1CodeableConcept
.... system S0..1uri
.... value S0..1string
.... period S0..1Period
.... assigner S0..1Reference(VhDir Organization)
... active S1..1boolean
... period S0..1Period
... organization S0..1Reference(VhDir Organization)
... participatingOrganization S0..1Reference(VhDir Organization)
... network S0..*Reference(VhDir Network)
... code S0..*CodeableConcept
... specialty S0..*CodeableConcept
... location S0..*Reference(VhDir Location)
... healthcareService S0..*Reference(VhDir Healthcare Service)
... telecom S0..*ContactPoint
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system S1..1code
.... value S1..1string
.... use S0..1code
.... rank S0..1positiveInt
.... period S0..1Period
... endpoint S0..*Reference(VhDir Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation I0..*Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifiers that are specific to this role
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode S1..1codeactive|inactive|issued in error|revoked|pending
Binding: VhDir Identifier Status Value Set (example)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General': 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this organization affiliation record is in active use
... period SΣ0..1PeriodThe period during which the participatingOrganization is affiliated with the primary organization
... organization SΣ0..1Reference(VhDir Organization)Organization where the role is available
... participatingOrganization SΣ0..1Reference(VhDir Organization)Organization that provides/performs the role (e.g. providing services or is a member of)
... network SΣ0..*Reference(VhDir Network)Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code SΣ0..*CodeableConceptDefinition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example)
... specialty SΣ0..*CodeableConceptSpecific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred)
... location SΣ0..*Reference(VhDir Location)The location(s) at which the role occurs
... healthcareService S0..*Reference(VhDir Healthcare Service)Healthcare services provided through the role
... telecom SΣ0..*ContactPointContact details at the participatingOrganization relevant to this Affiliation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension S0..*ExtensionDays of week
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"daysOfWeek"
...... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
..... extension S0..1ExtensionAll day
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension S0..1ExtensionAvailable start time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension S0..1ExtensionAvailable end time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableEndTime"
...... valueTime 1..1timeAvailable end time
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
..... valueReference S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... endpoint S0..*Reference(VhDir Endpoint)Technical endpoints providing access to services operated for this role

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Supported Searches

  1. GET [base]/OrganizationAffiliation?active=[code]

    Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/OrganizationAffiliation-active


  1. GET [base]/OrganizationAffiliation?organizationaffiliation-endpoint=[id]

    Support: SHOULD support search by the organizationaffiliation-endpoint parameter

    • with a target type: Endpoint
    • including these search paramaters which may be chained: endpoint-identifier, endpoint-connection-type, endpoint-organization

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-identifier=[code]

    Support: SHALL support search by the organizationaffiliation-identifier parameter

    • including the modifiers: text, ofType

  1. GET [base]/Organization?organizationaffiliation-identifier-assigner=[id]

    Support: MAY support search by the organizationaffiliation-identifier-assigner parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: organization-identifier, organization-name

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-location=[id]

    Support: SHALL support search by the organizationaffiliation-location parameter

    • with a target type: Location
    • including the modifiers: above, below
    • including these search paramaters which may be chained: location-identifier, location-type, location-address, location-organization

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-network=[id]

    Support: SHOULD support search by the organizationaffiliation-network parameter

    • with a target type: Organization
    • including these search paramaters which may be chained: organization-identifier, organization-name, organization-partof

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-participating-org=[id]

    Support: SHALL support search by the organizationaffiliation-participating-org parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: organization-identifier, organization-name, organization-address, organization-partof, organization-type

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-primary-organization=[id]

    Support: SHALL support search by the organizationaffiliation-primary-organization parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: organization-identifier, organization-type, organization-address, organization-name, organization-partof

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-role=[code]

    Support: SHALL support search by the organizationaffiliation-role parameter

    • including the modifiers: text

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-service=[id]

    Support: SHOULD support search by the organizationaffiliation-service parameter

    • with a target type: HealthcareService
    • including these search paramaters which may be chained: healthcareservice-identifier, healthcareservice-category, healthcareservice-organization, healthcareservice-location

  1. GET [base]/OrganizationAffiliation?organizationaffiliation-specialty=[code]

    Support: SHOULD support search by the organizationaffiliation-specialty parameter

    • including the modifiers: text

  1. GET [base]/Organization?organizationaffiliation-via-intermediary=[id]

    Support: MAY support search by the organizationaffiliation-via-intermediary parameter

    • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location