BC Provider Location Registry FHIR Implementation Guide
1.0.0 - fhirVersion-4.0; BCPLRVersion=1
BC Provider Location Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-affiliation | Version: 1.0.0 | |||
Active as of 2024-05-15 | Computable Name: BCOrganizationAffiliation |
General constraints on the OrganizationAffiliation resource for use in the BC Provider Registry project.
This profile sets the minimum expectations for an OrganizationAffiliation resource that is used to convey the relationship between two Organizations or between an Organization and the Locations associated with it.
This OrganizationAffiliation profile has the following mandatory elements:
Each OrganizationAffiliation must have:
Each OrganizationAffiliation must have either:
Each OrganizationAffilation must support:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OrganizationAffiliationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | C | 0..* | OrganizationAffiliationProfile | OrganizationAffiliation Profile invariant-rltn-2: One participating organization or one location allowed; not both. |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
identifier | S | 0..* | Identifier | Business identifiers that are specific to this role |
active | S | 0..1 | boolean | Whether this organization affiliation record is in active use |
period | S | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
organization | S | 1..1 | Reference(BCOrganization) | Organization where the role is available |
participatingOrganization | S | 0..1 | Reference(BCOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
code | S | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays |
location | S | 0..* | Reference(BCLocation) | The location(s) at which the role occurs |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
invariant-rltn-2 | error | OrganizationAffiliation | One participating organization or one location allowed; not both. : participatingOrganization.count()=1 xor location.count()=1 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | C | 0..* | OrganizationAffiliationProfile | OrganizationAffiliation Profile invariant-rltn-2: One participating organization or one location allowed; not both. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role |
active | SΣ | 0..1 | boolean | Whether this organization affiliation record is in active use |
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
organization | SΣ | 1..1 | Reference(BCOrganization) | Organization where the role is available |
participatingOrganization | SΣ | 0..1 | Reference(BCOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
code | SΣ | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. |
location | SΣ | 0..* | Reference(BCLocation) | The location(s) at which the role occurs |
Documentation for this format |
Path | Conformance | ValueSet | URI |
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | OrganizationAffiliation | If 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-4 | error | OrganizationAffiliation | If 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-5 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
invariant-rltn-2 | error | OrganizationAffiliation | One participating organization or one location allowed; not both. : participatingOrganization.count()=1 xor location.count()=1 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
OrganizationAffiliation | C | 0..* | OrganizationAffiliationProfile | OrganizationAffiliation Profile invariant-rltn-2: One participating organization or one location allowed; not both. | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) | ||||
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
active | SΣ | 0..1 | boolean | Whether this organization affiliation record is in active use | ||||
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
organization | SΣ | 1..1 | Reference(BCOrganization) | Organization where the role is available | ||||
participatingOrganization | SΣ | 0..1 | Reference(BCOrganization) | 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 | SΣ | 1..1 | 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 | SΣ | 0..* | Reference(BCLocation) | 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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
OrganizationAffiliation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard | ||||
OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | OrganizationAffiliation | If 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-4 | error | OrganizationAffiliation | If 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-5 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
invariant-rltn-2 | error | OrganizationAffiliation | One participating organization or one location allowed; not both. : participatingOrganization.count()=1 xor location.count()=1 |
This structure is derived from OrganizationAffiliationProfile
Differential View
This structure is derived from OrganizationAffiliationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | C | 0..* | OrganizationAffiliationProfile | OrganizationAffiliation Profile invariant-rltn-2: One participating organization or one location allowed; not both. |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
identifier | S | 0..* | Identifier | Business identifiers that are specific to this role |
active | S | 0..1 | boolean | Whether this organization affiliation record is in active use |
period | S | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
organization | S | 1..1 | Reference(BCOrganization) | Organization where the role is available |
participatingOrganization | S | 0..1 | Reference(BCOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
code | S | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays |
location | S | 0..* | Reference(BCLocation) | The location(s) at which the role occurs |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
invariant-rltn-2 | error | OrganizationAffiliation | One participating organization or one location allowed; not both. : participatingOrganization.count()=1 xor location.count()=1 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | C | 0..* | OrganizationAffiliationProfile | OrganizationAffiliation Profile invariant-rltn-2: One participating organization or one location allowed; not both. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) |
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role |
active | SΣ | 0..1 | boolean | Whether this organization affiliation record is in active use |
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
organization | SΣ | 1..1 | Reference(BCOrganization) | Organization where the role is available |
participatingOrganization | SΣ | 0..1 | Reference(BCOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
code | SΣ | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. |
location | SΣ | 0..* | Reference(BCLocation) | The location(s) at which the role occurs |
Documentation for this format |
Path | Conformance | ValueSet | URI |
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | OrganizationAffiliation | If 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-4 | error | OrganizationAffiliation | If 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-5 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
invariant-rltn-2 | error | OrganizationAffiliation | One participating organization or one location allowed; not both. : participatingOrganization.count()=1 xor location.count()=1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
OrganizationAffiliation | C | 0..* | OrganizationAffiliationProfile | OrganizationAffiliation Profile invariant-rltn-2: One participating organization or one location allowed; not both. | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
endReason | S | 0..1 | CodeableConcept | BC End Reason Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-end-reason-extension Binding: BC End Reason Value Set (required) | ||||
owner | S | 0..1 | Identifier | BC Owner Extension URL: http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-owner-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
active | SΣ | 0..1 | boolean | Whether this organization affiliation record is in active use | ||||
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
organization | SΣ | 1..1 | Reference(BCOrganization) | Organization where the role is available | ||||
participatingOrganization | SΣ | 0..1 | Reference(BCOrganization) | 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 | SΣ | 1..1 | 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 | SΣ | 0..* | Reference(BCLocation) | 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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
OrganizationAffiliation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
OrganizationAffiliation.code | example | OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role from the FHIR Standard | ||||
OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | OrganizationAffiliation | If 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-4 | error | OrganizationAffiliation | If 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-5 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
invariant-rltn-2 | error | OrganizationAffiliation | One participating organization or one location allowed; not both. : participatingOrganization.count()=1 xor location.count()=1 |
This structure is derived from OrganizationAffiliationProfile
Other representations of profile: CSV, Excel, Schematron