BC Provider Location Registry FHIR Implementation Guide
1.0.0 - fhirVersion-4.0; BCPLRVersion=1 Canada flag

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

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Capabilities

PLR Capability Statements

BC PLR Client Capability Statement

This capability statement describes the use case that is supported by the BC FHIR implementation of PLR.

  • Distributions - used when PLR is communicating a change in a single Practitioner, Organization, or Location
BC PLR Server Capability Statement

This capability statement is listing the RESTful resources that are exposed as well as the three use cases that are supported by the BC FHIR implementation of PLR (see json or XML for more details):

  • Maintain - used when an external source is communicating a change to PLR
  • Batch - allows for the sending of multiple Maintain transactions at one time (not implemented yet)
  • Queries - a set of operations are defined that allow the querying of PLR FHIR instances (entityQuery and extendedQuery)

All POST and PUT Requests are sent using a Paramaters resource and the Response is always a Bundle resource containing an OperationOutcome and the expected profile(s) (BCPractitioner, BCPractitionerBundle ect …)

Operations

Operation definitions

Maintain PLR entities.

This operation is used to create and update the resources that represent a Provider or Facility.
PLR entities sent out in a distribution.

This operation is used to distribute the resources that represent a Provider or Facility.
Query for a location that returns associated resources

This operation is used to query for an location and will return the information for that location along with any instances that can be found by following associations to other providers, organizations, or location.
Query for a location without returning associations

This operation is used to query for an location and will return the information for that location without following associations to other practitioner, organizations, or locations.
Query for a Practitioner that returns associated resources

This operation is used to query for a provider and will return the information for that provider along with any instances that can be found by following associations to other providers, organizations, or facilities.
Query for a practitioner without returning associations

This operation is used to query for a practitioner and will return the information for that practitioner without following associations to other providers, organizations, or facilities.
Query for an organization that returns associated resources

This operation is used to query for an organization and will return the information for that organization along with any instances that can be found by following associations to other practitioners, organizations, or locations.
Query for an organization without returning associations

This operation is used to query for an organization and will return the information for that organization without following associations to other providers, organizations, or facilities.

Operations Request Examples

Operation request examples

Example-Request-Add-Location

Example Parameters to add an Location (aka Facility).
Example-Request-Add-Organization

Example Parameters to add an Organizational Provider.
Example-Request-Add-Practitioner

Example Parameters to add an Individual Provider.
Example-Request-Distribution-Organization

Example Parameters to distribute an Individual Provider.
Example-Request-Distribution-Practitioner

Example Parameters to distribute an Individual Provider.
Example-Request-Update-License-Practitioner

Example Parameters to update the license of an Individual Provider.
Example-Request-Update-Location

Example Parameters to update a Location (aka Facility).
Example-Request-Update-Practitioner

Example Parameters to update various attributes of a Individual Provider.

Operations Response Examples

Operation response examples

Example-Response-Add-Location

Example Parameters to add an Location (aka Facility).
Example-Response-Add-Organization

Example Parameters for Add Organization Provider response.
Example-Response-Add-Practitioner

Example Parameters for Add Individual Provider response.
Example-Response-Query-Organization-Bundle

An example search response bundle with Organizational Provider.
Example-Response-Query-Practitioner-Bundle

An example search response bundle with Individual Provider.
Example-Response-Update-Organization

Example Parameters for Update Organization Provider response.
Example-Response-Update-Practitioner

Example Parameters for Update Individual Provider response.

Bundles

Inbound Distribution/Maintain and Batch Bundles

BCBatchBundle

A Bundle that is used in the PLR Batch operation.
BCLocationBundle

A bundle that submits Location information.
BCOrganizationBundle

A bundle that submits Organization and OrganizationAffiliation information.
BCPractitionerBundle

A bundle that submits Practitioner and PractitionerRole information.
Example-AddLocation-Bundle

An example of bundle that is adding a location.
Example-AddOrganization-Bundle

Example of a Bundle of resources that are needed to create an Organization.
Example-AddPractitioner-Bundle

Example of a bundle of resources sent when requesting a practitioner create.
Example-Batch-Bundle

An example of a Batch Bundle that contains one each of a Practitioner bundle, Organization bundle, and a Location bundle.
Example-DistributePractitioner-Bundle

Example of a bundle of resources sent when distributing a Practitioner.

Practitioner

Artifacts associated with Practitioners

BCPractitioner

General constraints on the Practitioner resource for use in the BC Provider Registry project.
BCPractitionerRole

General constraints on the PractitionerRole resource for use in the BC Provider Registry project.
BCRoleRelationships

General constraints on the PractitionerRole resource for use in the BC Provider Registry project to describe relationships.

Organization

Artifacts associated with Organizations

BCOrganization

General constraints on the Organization resource for use in the BC Provider Registry project.
BCOrganizationAffiliation

General constraints on the OrganizationAffiliation resource for use in the BC Provider Registry project.

Facility

Artifacts associated with Facilities

BCLocation

General constraints on the Location resource for use in the BC Provider Registry project.

Healthcare Service

Artifacts associated with Healthcare Services - no active development in PLR around this for now

BCCatalogueService

PLR Enhancement that describes services as they would be found in a catalogue.
BCClinicalService

PLR Enhancement that describes services that a clinic provides.

Care Team

Artifacts associated with Care Teams - no active development in PLR around this for now

BCCareTeam

PLR Enhancement representing a collection of practitioners that provide services. There is no active development planned around this in PLR for now.
BCPrimaryNetwork

PLR Enhancement representing a primary care network of practitioners that provide services. There is no active development planned around this in PLR for now.

RESTful Query Response Examples

RESTful Query Response Examples

Example-GET-Location-Response

Example of a response returning one Location
Example-GET-Organization-Response

Example of a response returning one Organization.
Example-GET-Practitioner-Param-Response

Example of a response returning two Practioners.
Example-GET-Practitioner-Response

Example of a response returning one Practioners.

Extensions

Extensions used across all groupings

BC Address Validation Extension

BC extension for address validation status codes.
BC Birth Place Extension

Captures the place where a patient/practitioner/person was born.
BC Birth Time Extension

Adds birth time to the birth date.
BC Communication Purpose Extension

BC extension for communication purpose codes.
BC Confidentiality Extension

Indicates the confidentiality of a BC provider’s (practitioner or organization) information.
BC End Reason Extension

Tracking end reason.
BC Facility Details Extension

Provides the details of a facility as represented by a FHIR location.
BC Facility Health Service Area Extension

A wrapper extension that will allow to list all the health service area, including the PCN and the Community Health Service Area.
BC Facility Physical Address Extension

An optional physical address for the facility.
BC License Status Extension

Tracking the status and changes to the status of a practitioner/organization license.
BC Name Use Extension

Allows for use on a simple name string.
BC Notes Extension

Notes about the practitioner/location/organization.
BC Owner Extension

Tracking the owner.
BC Practitioner Conditions Extension

Conditions on the provider’s role
BC Practitioner Date of Death Extension

The Date of Death of a Practitioner.
BC Practitioner Disciplinary Actions Extension

Provides details of disciplinary actions against the provider.
BC Practitioner Qualification Extension

The qualifications extensions.
BC Practitioner to Location Type Extension.

The relationship type of a Practitioner to Location relationship.
BC Practitioner to Organization or Practitioner to Practitioner Type Extension.

The relationship type of a Practitioner to Organization or Practitioner to Practitioner relationship.
BC Practitioner to Practitioner Relationship Extension

Allows for relationships of practitioners to practitioners without needing CareTeam semantics.
BC Specialty Source Extension

The specialty source.
BC Valid Period Extension

The period for when the extended element is valid.
BCOperationOutcome

OperationOutcome for BC.

Datatypes

Artifacts associated with datatypes

BCAddress

Adds an end reason, communication purpose and validation status to the address.
BCContactPoint

Adds an end reason and extra contact information.
BCHumanName

Adds an end reason and a use code to a name.
BCIdentifier

Adds an end reason to the identifier.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

BC Facility Community Health Service Area Extension

A code that represents the Community Health Service Area (CHSA) that the location is a part of.
BC Facility Health Authority Area Extension

A code that represents the health authority area that the location is a part of.
BC Facility Health Service Delivery Area Extension

A code that represents the Health Service Delivery Area (HSDA)that the location is a part of.
BC Facility Local Health Area Extension

A code that represents the Local Health Area (LHA) that the location is a part of.
BC Facility Primary Care Network Extension

A code that represents the Primary Care Network (PCN) that the location is a part of.
Extension for BC Organization to add Primary Care Clinic details

A wrapper extension that will allow to add the Primary Care Clinic details.
Extension for the clinic business legal name.

The clinic business lagal name
Extension to indicate if the clinic is part of the Primary Care Initiative.

Flag that indicates if (Primary Care) Clinic is part of the PrimaryCare Initiative. not all PC clinic are part of this initiative
Extension to represent Availability, or hours of operation, for clinic, or other Profiles

Can represent the Available time or the Not Avaialble details
Extension to represent clinic Owners.

The (Primary Care) Clinic Owner - still pending some detailed requirements
Extension to represent the Clinic Ownership type.

The (Primary Care) Clinic Ownership type, the expected value is one from Health Authority Owned/Operated, First Nation Health Authority Owned/Operated, Physician Owned/Operated, Non-Profit Society, Non-Physician Corporation, Other
Extension to represent the Clinic Payee number.

The (Primary Care) Clinic Payee number
Extension to represent the Clinic Service Delivery type.

The (Primary Care) Clinic Service Delivery type, the expected value is one from Longitudinal, Episodic, and Mixed
Extension to represent the Clinic type.

The (Primary Care) Clinic type, the expected value is one from UPCC, FNPCI, NPCC, CHC, Walk-In/Episodic Care Clinic, Family Practice, Longitudinal Primary Care Practice, Hybrid Primary Care Practice
Extension to represent the available Time, or hours of operation, for clinic, or other Profiles

Can represent the Available time
Extension to represent the details when an item is NOT available for clinic, or other Profiles

Can represent the Not Avaialble details

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

BC Address Validation Status Value Set

BC address validation status value set.
BC Communication Purpose Value Set

BC communication purpose value set.
BC End Reason Value Set

BC end reason value set.
BC Expertise Value Set

BC Expertise value set.
BC Language Value Set

BC Language value set.
BC License Status Class Value Set

BC specific license status class value set.
BC License Status Reason Value Set

BC specific license status reason value set.
BC License Status Value Set

BC specific license status value set.
BC Organization Role Code Value Set

BC Organization Role Codes.
BC Practitioner Qualification Value Set

BC specific qualification value set.
BC Practitioner Role Code Value Set

BC Practitioner Role Codes.
BC Relationship Type Value Set

BC relationship type value set.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

BC Service type codes

BC Service type Codes

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example-AddLocationWithLinks-Bundle

An example of bundle that is adding a location.
Example-AddLocationWithLinks-Bundle-Response

An example of bundle that is adding a location.
Example-AddPractitioner-Bundle-Response

Example of a bundle of resources sent when responding to a practitioner create.
Example-AddPractitioner-Practitioner

Example of a BC practitioner that is being created.
Example-Another-Atomic-Practitioner

Example of another generic Practitioner.
Example-Atomic-Location

Example of a Location.
Example-Atomic-Organization

Example of an Organization.
Example-Atomic-OrganizationAffiliation-LocRef

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-Atomic-OrganizationAffiliation-OrgRef

Example of the OrganizationAffiliation for Organization to Organization relationship.
Example-Atomic-Practitioner

Example of generic Practitioner.
Example-Atomic-PractitionerRole-LocRef

Example of the PractitionerRole for Practitioner to Location relationship.
Example-Atomic-PractitionerRole-OrgRef

Example of the PractitionerRole for Practitioner to Organization relationship.
Example-Atomic-PractitionerRole-RoleSpecialty

Example of the PractitionerRole with Speciality.
Example-Credential-Granting-Institution

Example of an credential granting institution.
Example-DistributeOrganization-Bundle

Example of a bundle of resources sent when distributing a Organization.
Example-DistributePractitioner-Bundle-forTesting

Example of a bundle of resources sent when distributing a Practitioner.
Example-GET-OrganizationAffiliation-Response

Example of a response returning one OrganizationAffiliation
Example-GET-OrganizationAffiliation-byOrganization-Response

Example of a response returning list of OrganizationAffiliation
Example-GET-PractitionerRole-Response

Example of a response returning one PractitionerRole
Example-GET-PractitionerRole-byPractitioner-Response

Example of a response returning all the PractitionerRole for one practitioner
Example-Individual-Provider-Bundle

An example of a Provider Bundle, i.e. A Practitioner and PractitionerRole in a Bundle that represents a PLR Individual Provider.
Example-Location-For-Add

Example of a Location.
Example-Location-For-Add-Response

Example of a Location.
Example-Location-For-Update

Example of a Location for update.
Example-OperationOutcome-7018

OperationOutcome example for Individual Provider search - wildcard error.
Example-OperationOutcome-7047

OperationOutcome example for Individual Provider search - no provider records found.
Example-OperationOutcome-7049

OperationOutcome example for Individual Provider search - too many results.
Example-OperationOutcome-MaintainSuccess

OperationOutcome example of a success message.
Example-OperationOutcome-Success

OperationOutcome example of a success message.
Example-Organization-1

Example of an Organization.
Example-Organization-1-Update

Example of an Organization.
Example-Organization-2

Example of generic Organization.
Example-Organization-PrimaryCare

Example of an Primary Care clinic
Example-Organization-Response

Example of an Organization that is being created.
Example-OrganizationAffiliation-2-LocRef-FromOrg

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-3-LocRef-FromOrg

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-3-OrgRef-FromOrg

Example of the OrganizationAffiliation for Organization to Organization relationship.
Example-OrganizationAffiliation-Loc1

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-Loc1-U

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-Loc2

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-Loc2-U

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-LocRef-FromOrg-2

Example of the OrganizationAffiliation for Organization to Location relationship.
Example-OrganizationAffiliation-OrgRef-FromOrg-1

Example of the OrganizationAffiliation for Organization to Organization relationship.
Example-OrganizationAffiliation-OrgRef-FromOrg-2

Example of the OrganizationAffiliation for Organization to Organization relationship.
Example-Organizational-Provider-Bundle

An example of a Provider Bundle, i.e. A Organization and PractitionerRole and OrganizationAffiliation in a Bundle that represents a PLR Organizational Provider.
Example-Practitioner

Example of generic Practitioner.
Example-Practitioner-Response

Example of generic Practitioner response.
Example-Practitioner-Response-test

Example of generic Practitioner response.
Example-Practitioner-Update

Example Practitioner resource for updating License Status.
Example-Practitioner-UpdateLicense

Example Practitioner resource for updating License Status.
Example-PractitionerRole-1-Role-FromPractitioner

Example of the PractitionerRole with Speciality.
Example-PractitionerRole-1-Role-FromPractitioner-Response

Example of the PractitionerRole with Speciality.
Example-PractitionerRole-1-Role-FromPractitioner-Response-test

Example of the PractitionerRole with Speciality.
Example-PractitionerRole-1-Role-FromPractitioner-Update-Response

Example of the PractitionerRole with Speciality.
Example-PractitionerRole-1-Role-Update

Example of the PractitionerRole with Speciality.
Example-PractitionerRole-2-OrgRef-FromPractitioner

Example of the PractitionerRole for Practitioner to Organization relationship.
Example-PractitionerRole-2-OrgRef-FromPractitioner-Response

Example of the PractitionerRole for Practitioner to Organization relationship.
Example-PractitionerRole-3-LocRef-FromPractitioner

Example of the PractitionerRole for Practitioner to Location relationship.
Example-PractitionerRole-3-LocRef-FromPractitioner-Response

Example of the PractitionerRole for Practitioner to Location relationship.
Example-PractitionerRole-4-PracRef-FromOrg

Example of the PractitionerRole for Practitioner to Practitioner relationship.
Example-PractitionerRole-4-PracRef-FromOrg-Response

Example of the PractitionerRole for Practitioner to Practitioner relationship.
Example-PractitionerRole-5-OrgRef-FromPractitioner

Example of the PractitionerRole for Practitioner to Organization relationship.
Example-PractitionerRole-5-PracRef-FromLoc

Example of the PractitionerRole for Practitioner to Practitioner relationship.
Example-PractitionerRole-5-PracRef-FromLoc-Response

Example of the PractitionerRole for Practitioner to Practitioner relationship.
Example-PractitionerRole-Loc3

Example of the PractitionerRole for Practitioner to Location relationship.
Example-PractitionerRole-Loc3-U

Example of the PractitionerRole for Practitioner to Location relationship.
Example-PractitionerRole-LocRef-FromPractitioner-3

Example of the PractitionerRole for Practitioner to Location relationship.
Example-PractitionerRole-OrgRef-FromPrac-1-Update

Example of the PractitionerRole for Practitioner to Organization relationship update.
Example-PractitionerRole-OrgRef-FromPractitioner-1

Example of the PractitionerRole for Practitioner to Organization relationship.
Example-PractitionerRole-OrgRef-FromPractitioner-2

Example of the PractitionerRole for Practitioner to Organization relationship.
Example-PractitionerRole-Role-FromPrac-CPSID

Example of the PractitionerRole with Speciality.
Example-PractitionerRole-Role-Update-Specialty

Example of the PractitionerRole with Speciality.
Example-Qualification-Organization

Example of an organization’s qualifications.
Example-Request-Update-Organization

Example Parameters to update an Organizational Provider.
Example-UpdateLocationWithLinks-Bundle

An example of bundle that is updating a location.
Example-UpdateOrganization-Bundle

Example of a Bundle of resources that are needed to update an Organization.
Example-UpdateOrganization-Bundle-Response

Example of a Bundle of resources representing a Organization Response.
Example-UpdatePractitioner-Bundle

Example of a bundle to update an Indivivdual Provider.
Example-UpdatePractitioner-Bundle-Response

Example of a bundle of resources sent when responding to a practitioner update.
Example-UpdatePractitioner-LicenseStatus-Bundle

Example of a bundle to update an Indivivdual Provider’s License Status.