FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/bc-plr-server-capability-statement

Packagefhir.ca-bc.provider
Resource TypeCapabilityStatement
Idbc-plr-server-capability-statement
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=fhir.ca-bc.provider@1.0.1&canonical=http://hlth.gov.bc.ca/fhir/provider/CapabilityStatement/bc-plr-server-capability-statement
URLhttp://hlth.gov.bc.ca/fhir/provider/CapabilityStatement/bc-plr-server-capability-statement
Version1.0.0
Statusactive
Date2024-03-20
NameBCPLRServerCapabilityStatement
TitleBC PLR Server Capability Statement
Realmus
Authorityhl7
DescriptionThis 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 ...)
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
bc-entity-location-queryQuery for a location without returning associations
bc-entity-organization-queryQuery for an organization without returning associations
bc-entity-practitioner-queryQuery for a practitioner without returning associations
bc-extended-location-queryQuery for a location that returns associated resources - FUTURE
bc-extended-organization-queryQuery for an organization that returns associated resources - FUTURE
bc-extended-practitioner-queryQuery for a Practitioner that returns associated resources - FUTURE
bc-maintainMaintain PLR entities.
StructureDefinition
bc-location-bundleBCLocationBundle
bc-locationBCLocation
bc-organization-bundleBCOrganizationBundle
bc-organizationBCOrganization
bc-practitioner-bundleBCPractitionerBundle
bc-practitionerBCPractitioner

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement bc-plr-server-capability-statement

BC PLR Server Capability Statement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json
  • Supported Patch Formats:
  • Published on: 2024-03-20
  • Published by: BC Ministry of Health

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Practitionerhttp://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-practitioner
Additional supported profiles:
  BCPractitionerBundle
yyidentifier, _id, family, given, gender, address-city, _hasPractitionerRole:practitioner$entityQuery, $extendedQuery
Organizationhttp://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization
Additional supported profiles:
  BCOrganizationBundle
yyidentifier, name, type, address-city$entityQuery, $extendedQuery
Locationhttp://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location
Additional supported profiles:
  BCLocationBundle
yyidentifier, address-city, address-line1, otheraddress-line1, healthServiceDeliveryArea, healthAuthority, communityHealthServiceArea, localHealthArea$entityQuery, $extendedQuery

Resource Conformance: supported Practitioner

Base System Profile
BCPractitioner
Profile Conformance
SHALL
Reference Policy

Supported Profiles

BCPractitionerBundle

Interaction summary
  • Supports
    read

    RESTful GET service

    search-type

    RESTful Search

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifierstring

Practitioner identifier, format <naming-system>|<value>

SHALL_idstring

Practitioner IPC, unique identifier

SHALLfamilystring

Practitioner family name

SHALLgivenstring

Practitioner given name

SHALLgenderstring

Practitioner gender

SHALLaddress-citystring

Practitioner city

SHALL_hasstring

PractitionerRole:practitioner:role= <role>

 
Extended Operations
ConformanceOperationDocumentation
SHALL$entityQuery
SHALL$extendedQuery

FUTURE

Resource Conformance: supported Organization

Base System Profile
BCOrganization
Profile Conformance
SHALL
Reference Policy

Supported Profiles

BCOrganizationBundle

Interaction summary
  • Supports
    read

    RESTful GET service

    search-type

    RESTful Search

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifierstring

Organization identifier, format <naming-system>|<value>

SHALLnamestring

Organization name

SHALLtypestring

Organization role type

SHALLaddress-citystring

Organization city

 
Extended Operations
ConformanceOperationDocumentation
SHALL$entityQuery
SHALL$extendedQuery

FUTURE

Resource Conformance: supported Location

Base System Profile
BCLocation
Profile Conformance
SHALL
Reference Policy

Supported Profiles

BCLocationBundle

Interaction summary
  • Supports
    read

    RESTful GET service

    search-type

    RESTful Search

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifierstring

Location identifier, format <naming-system>|<value>

SHALLaddress-citystring

Location city

SHALLaddress-line1string

Location city

SHALLotheraddress-line1string

Location city

SHALLhealthServiceDeliveryAreastring

Location health Service Delivery Area

SHALLhealthAuthoritystring

Location health Authority

SHALLcommunityHealthServiceAreastring

Location community Health Service Area

SHALLlocalHealthAreastring

Location local Health Area

 
Extended Operations
ConformanceOperationDocumentation
SHALL$entityQuery
SHALL$extendedQuery

FUTURE

Operations

Use


Source

{
  "resourceType": "CapabilityStatement",
  "id": "bc-plr-server-capability-statement",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hlth.gov.bc.ca/fhir/provider/CapabilityStatement/bc-plr-server-capability-statement",
  "version": "1.0.0",
  "name": "BCPLRServerCapabilityStatement",
  "title": "BC PLR Server Capability Statement",
  "status": "active",
  "date": "2024-03-20",
  "publisher": "BC Ministry of Health",
  "contact": [
    {
      "name": "BC Ministry of Health",
      "telecom": [
        {
          "system": "url",
          "value": "https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/health"
        }
      ]
    }
  ],
  "description": "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):\n* Maintain - used when an external source is communicating a change to PLR\n* Batch - allows for the sending of multiple Maintain transactions at one time (not implemented yet)\n* Queries - a set of operations are defined that allow the querying of PLR FHIR instances (entityQuery and extendedQuery)\n\nAll 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 ...)",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CA",
          "display": "Canada"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json"
  ],
  "_format": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    }
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "Practitioner",
          "profile": "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-practitioner",
          "supportedProfile": [
            "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-practitioner-bundle"
          ],
          "interaction": [
            {
              "code": "read",
              "documentation": "RESTful GET service"
            },
            {
              "code": "search-type",
              "documentation": "RESTful Search"
            }
          ],
          "searchRevInclude": [
            "PractitionerRole:practitioner"
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "string",
              "documentation": "Practitioner identifier, format <naming-system>|<value>"
            },
            {
              "name": "_id",
              "type": "string",
              "documentation": "Practitioner IPC, unique identifier"
            },
            {
              "name": "family",
              "type": "string",
              "documentation": "Practitioner family name"
            },
            {
              "name": "given",
              "type": "string",
              "documentation": "Practitioner given name"
            },
            {
              "name": "gender",
              "type": "string",
              "documentation": "Practitioner gender"
            },
            {
              "name": "address-city",
              "type": "string",
              "documentation": "Practitioner city"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "PractitionerRole:practitioner:role= <role>"
            }
          ],
          "operation": [
            {
              "name": "entityQuery",
              "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-entity-practitioner-query"
            },
            {
              "name": "extendedQuery",
              "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-practitioner-query",
              "documentation": "FUTURE"
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization",
          "supportedProfile": [
            "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization-bundle"
          ],
          "interaction": [
            {
              "code": "read",
              "documentation": "RESTful GET service"
            },
            {
              "code": "search-type",
              "documentation": "RESTful Search"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "string",
              "documentation": "Organization identifier, format <naming-system>|<value>"
            },
            {
              "name": "name",
              "type": "string",
              "documentation": "Organization name"
            },
            {
              "name": "type",
              "type": "string",
              "documentation": "Organization role type"
            },
            {
              "name": "address-city",
              "type": "string",
              "documentation": "Organization city"
            }
          ],
          "operation": [
            {
              "name": "entityQuery",
              "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-entity-organization-query"
            },
            {
              "name": "extendedQuery",
              "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-organization-query",
              "documentation": "FUTURE"
            }
          ]
        },
        {
          "type": "Location",
          "profile": "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location",
          "supportedProfile": [
            "http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location-bundle"
          ],
          "interaction": [
            {
              "code": "read",
              "documentation": "RESTful GET service"
            },
            {
              "code": "search-type",
              "documentation": "RESTful Search"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "string",
              "documentation": "Location identifier, format <naming-system>|<value>"
            },
            {
              "name": "address-city",
              "type": "string",
              "documentation": "Location city"
            },
            {
              "name": "address-line1",
              "type": "string",
              "documentation": "Location city"
            },
            {
              "name": "otheraddress-line1",
              "type": "string",
              "documentation": "Location city"
            },
            {
              "name": "healthServiceDeliveryArea",
              "type": "string",
              "documentation": "Location health Service Delivery Area"
            },
            {
              "name": "healthAuthority",
              "type": "string",
              "documentation": "Location health Authority"
            },
            {
              "name": "communityHealthServiceArea",
              "type": "string",
              "documentation": "Location community Health Service Area"
            },
            {
              "name": "localHealthArea",
              "type": "string",
              "documentation": "Location local Health Area"
            }
          ],
          "operation": [
            {
              "name": "entityQuery",
              "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-entity-location-query"
            },
            {
              "name": "extendedQuery",
              "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-location-query",
              "documentation": "FUTURE"
            }
          ]
        }
      ],
      "operation": [
        {
          "name": "maintain",
          "definition": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-maintain",
          "documentation": "A BC resource Bundle is sent to create/update one resource"
        }
      ]
    }
  ]
}