Provider Location Registry (PLR)

PLR Profiles and Operations are created and maintained external to the LRA project and is provided here as an aid for implementers of the LRA in finding the base profile definitions. The reader should always verify the profile on the linked source page.

Overview

Provider Location Registry (PLR) is a full pass-through integration with LRA. This page documents the Provider and Location Registry (PLR) FHIR operations, profiles and Search URLs to be used via LRA Platform.
Please refer to the LRA Configuration page for information on authentication, authorization, environment, and endpoint details.

Important Links

Provider Location Registry FHIR IG: BC Provider Location Registry

Profiles: BC Practitioner, BC PractitionerRole, BC Organization, BC Location

Example Usage Scenarios

The following are example query usage scenarios for this profile:

  • Practitioner Query: Query for a Practitioner demographic and role information using search parameters such as family name, given name, role, and address city.
    Example Request: [base]/Practitioner/$entityQuery?family=Adam&given=William&role=RN&address-city=Vancouver
  • Organization Query: Query for an Organization using parameters such as name, description, and city.
    Example Request: [base]/Organization/$entityQuery?name=IHA&description=Hospital&address-city=Victoria
  • Location Query: Query for a Location using parameters such as address, local health area, and name.
    Example Request: [base]/Location/$entityQuery?address-line1=2387 FIR AVE&address-city=LUMBY&localHealthArea=Vernon&name=Hillside

Here is the example practitioner response bundle.

PLR Artefacts

The profiles and operations in this section use the same format as PLR, with no modifications by the LRA.

Artifact Name Description
Operation: Practitioner $entityQuery 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.
Operation: Organization $entityQuery 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.
Operation: Location $entityQuery 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.

Following are the list of profiles referenced by the above operations:

Artifact Name Description
BC Practitioner General constraints on the Practitioner resource for use in the BC Provider Registry project.
BC PractitionerRole General constraints on the PractitionerRole resource for use in the BC Provider Registry project.
BC Role Relationships General constraints on the PractitionerRole resource for use in the BC Provider Registry project to describe relationships.
BC Organization General constraints on the Organization resource for use in the BC Provider Registry project.
BC Organization Affiliation General constraints on the OrganizationAffiliation resource for use in the BC Provider Registry project.
BC Location General constraints on the Location resource for use in the BC Provider Registry project.

LRA Interaction Support

  1. Practitioner Search

    2. The following search parameters are implemented and supported by LRA for Practitioner queries (in compliance with PLR searching criterias and conformance):

    • identifier: Search by a unique practitioner identifier (e.g., medical license).
    • family: Search by practitioner's last name.
    • given: Search by practitioner's first name.
    • role: Search by practitioner's role (e.g., RN, MD).
    • language: Search by language codes, e.g. F01,E09.
    • expertise: Search by practitioner's expertise or specialty.
    • gender: Search by practitioner’s gender.
    • status: Search by practitioner’s current status (e.g., Active).
    • status-reason: Search by status reason.
    • withHistory: Include historical records in search results.
    • Additionally, there is a support for wildcard searches for family or given names.

     

    The following search parameters and combinations outline both mandatory and optional support. Mandatory parameters are denoted by SHALL, while optional parameters are indicated by SHOULD:

    1. SHALL support searching practitioner by an identifier using the identifier search parameter:

    2. SHALL support searching using a combination of family, given and at LEAST one of the following:

      • birthdate
      • status
      • status-reason
      • address-city
      • address-country
      • gender
      • language; or
      • expertise

    3. SHOULD support searching using the combination of the family, given AND address-city search parameters:

    4. SHOULD support searching using the combination of the family, given AND gender search parameters:

    5. SHOULD support searching using the combination of the family, given and any combination of status, status-reason, language or expertise search parameters:

    Practitioner Query Examples:

    • Read Practitioner: GET [Base]/Practitioner/IPC.00167968.BC.PRS/$entityQuery

    • Search by Identifier (for example: medical license identifier): GET [Base]/Practitioner/$entityQuery?identifier=https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-license-physician|MD5124

    • Search by Family and Given Name: GET [Base]/Practitioner/$entityQuery?family=PIPLott&given=Doris

    • Search by Role and City: GET [Base]/Practitioner/$entityQuery?family=PIPLott&given=Doris&role=RN&address-city=Richmond

    • Search by Expertise: GET [Base]/Practitioner/$entityQuery?family=PIPLott&given=Doris&expertise=ERN2

    • Wildcard Search: GET [Base]/Practitioner/$entityQuery?family=A*&given=A*

  2. Organization Search

    3. The following search parameters are implemented and supported by LRA for Organization queries (in compliance with PLR searching criterias and conformance):

    • identifier: Search by a unique organization identifier (e.g., IPC).
    • name: Search by organization name (wildcard support for name).
    • type: Search by organization type (e.g., CLINIC, HOSPITAL).
    • address-line1: Search by the first line of an address.
    • address-city: Search by the city of the organization.

    Organization Query Examples:

    • Read Organization: GET [Base]/Organization/IPC.00168669.BC.PRS/$entityQuery

    • Search by Identifier: GET [Base]/Organization/$entityQuery?identifier=https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-plr-ipc|IPC.00168669.BC.PRS

    • Search by Name and Type: GET [Base]/Organization/$entityQuery?name=test*&type=CLINIC

    • Search by Address city: GET [Base]/Organization/$entityQuery?name=Test Child and Family Center&address-city=Van*

  3. Location Search

    4. The following search parameters are implemented and supported by LRA for Location queries (in compliance with PLR searching criterias and conformance):
    • identifier: Search by a unique location identifier (e.g., IFC).
    • name: Search by location name.
    • address-line1: Search by the first line of an address.
    • address-city: Search by city where the location is situated.
    • healthAuthority: Search by the health authority governing the location.
    • healthServiceDeliveryArea: Search by the health service delivery area.
    • localHealthArea: Search by the local health area.
    • communityHealthServiceArea: Search by the community health service area.

    Location Query Examples:

    • Read Location: GET [Base]/Location/IFC.00000059.BC.PRS/$entityQuery

    • Search by Identifier: GET [Base]/Location/$entityQuery?identifier=https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-plr-ifc|IFC.00000059.BC.PRS

    • Search by Address Line and City: GET [Base]/Location/$entityQuery?address-line1=845 FORT ST&address-city=VICTORIA

    • Search by Health Authority and Service Area: GET [Base]/Location/$entityQuery?healthAuthority=Vancouver Island&healthServiceDeliveryArea=South Vancouver Island