Canadian Baseline
1.1.0 - CI Build Canada flag

Canadian Baseline, published by HL7 Canada - FHIR Implementation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Canada/ca-baseline/ and changes regularly. See the Directory of published versions

Resource Profile: OrganizationAffiliation Profile

Official URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-organizationaffiliation Version: 1.1.0
Draft as of 2019-04-05 Computable Name: OrganizationAffiliationProfile

Proposed constraints and extensions on the OrganizationAffiliation Resource. Generated as a first step toward creating a set of Canadian Baseline FHIR profiles.

This profile was generated from HL7 StructureDefinition on 2019-03-28 and constrained during a review of US Core against Canadian sources.

Note: This profile has been added to meet requirements met by ppr-ext-location-affiliation extension used in the ON PPR guide.

Intended use:

  • Resource Use
    • a Location is place
    • an Organization is a group of people
    • an Organization may have one or more location
  • ppr-ext-location-affiliation was used to add an element to a Location used identify an affiliated organization, including:
  • OrganizationAffiliation associates two Organizations and allows the location of the ParticipatingOrganization to be specified where:
    • OrganizationAffiliation.organization points to affiliated organization above
    • OrganizationAffiliation.participationOrganization points to the Organization that performs a role (Location.managingOrganization)
    • OrganizationAffiliation.code specifies the role the participatingOrganization plays (similar to Type above)
    • OrganizationAffiliation.location points to the Location where the role is performed

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* OrganizationAffiliation OrganizationAffiliation Profile
... period 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... organization 0..1 Reference(Organization Profile) Organization where the role is available
... participatingOrganization 0..1 Reference(Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
... location 0..* Reference(Location Profile) The location(s) at which the role occurs

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* OrganizationAffiliation OrganizationAffiliation Profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... period Σ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... participatingOrganization Σ 0..1 Reference(Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
... code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... location Σ 0..* Reference(Location Profile) The location(s) at which the role occurs

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationAffiliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* OrganizationAffiliation OrganizationAffiliation Profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifiers that are specific to this role
... active Σ 0..1 boolean Whether this organization affiliation record is in active use
... period Σ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... organization Σ 0..1 Reference(Organization Profile) Organization where the role is available
... participatingOrganization Σ 0..1 Reference(Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
... network Σ 0..* Reference(Organization) Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... specialty Σ 0..* CodeableConcept Specific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization.


... location Σ 0..* Reference(Location Profile) The location(s) at which the role occurs
... healthcareService 0..* Reference(HealthcareService) Healthcare services provided through the role
... telecom Σ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationAffiliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from OrganizationAffiliation

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* OrganizationAffiliation OrganizationAffiliation Profile
... period 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... organization 0..1 Reference(Organization Profile) Organization where the role is available
... participatingOrganization 0..1 Reference(Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
... location 0..* Reference(Location Profile) The location(s) at which the role occurs

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* OrganizationAffiliation OrganizationAffiliation Profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... period Σ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... participatingOrganization Σ 0..1 Reference(Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
... code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... location Σ 0..* Reference(Location Profile) The location(s) at which the role occurs

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationAffiliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationAffiliation 0..* OrganizationAffiliation OrganizationAffiliation Profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifiers that are specific to this role
... active Σ 0..1 boolean Whether this organization affiliation record is in active use
... period Σ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization
... organization Σ 0..1 Reference(Organization Profile) Organization where the role is available
... participatingOrganization Σ 0..1 Reference(Organization Profile) Organization that provides/performs the role (e.g. providing services or is a member of)
... network Σ 0..* Reference(Organization) Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
... code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization.


... specialty Σ 0..* CodeableConcept Specific specialty of the participatingOrganization in the context of the role
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization.


... location Σ 0..* Reference(Location Profile) The location(s) at which the role occurs
... healthcareService 0..* Reference(HealthcareService) Healthcare services provided through the role
... telecom Σ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OrganizationAffiliation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
OrganizationAffiliation.codeexampleOrganizationAffiliationRole
http://hl7.org/fhir/ValueSet/organization-role
from the FHIR Standard
OrganizationAffiliation.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationAffiliationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationAffiliationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationAffiliationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron