Package | fhir.ca-bc.provider |
Resource Type | CapabilityStatement |
Id | bc-plr-server-capability-statement |
FHIR Version | R4 |
Source | https://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 |
URL | http://hlth.gov.bc.ca/fhir/provider/CapabilityStatement/bc-plr-server-capability-statement |
Version | 1.0.0 |
Status | active |
Date | 2024-03-20 |
Name | BCPLRServerCapabilityStatement |
Title | BC PLR Server Capability Statement |
Realm | us |
Authority | hl7 |
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): * 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 ...) |
Kind | requirements |
No resources found
OperationDefinition | |
bc-entity-location-query | Query for a location without returning associations |
bc-entity-organization-query | Query for an organization without returning associations |
bc-entity-practitioner-query | Query for a practitioner without returning associations |
bc-extended-location-query | Query for a location that returns associated resources - FUTURE |
bc-extended-organization-query | Query for an organization that returns associated resources - FUTURE |
bc-extended-practitioner-query | Query for a Practitioner that returns associated resources - FUTURE |
bc-maintain | Maintain PLR entities. |
StructureDefinition | |
bc-location-bundle | BCLocationBundle |
bc-location | BCLocation |
bc-organization-bundle | BCOrganizationBundle |
bc-organization | BCOrganization |
bc-practitioner-bundle | BCPractitionerBundle |
bc-practitioner | BCPractitioner |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement bc-plr-server-capability-statement
json
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.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Practitioner | http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-practitioner Additional supported profiles: BCPractitionerBundle | y | y | identifier, _id, family, given, gender, address-city, _has | PractitionerRole:practitioner | $entityQuery , $extendedQuery | |||
Organization | http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-organization Additional supported profiles: BCOrganizationBundle | y | y | identifier, name, type, address-city | $entityQuery , $extendedQuery | ||||
Location | http://hlth.gov.bc.ca/fhir/provider/StructureDefinition/bc-location Additional supported profiles: BCLocationBundle | y | y | identifier, address-city, address-line1, otheraddress-line1, healthServiceDeliveryArea, healthAuthority, communityHealthServiceArea, localHealthArea | $entityQuery , $extendedQuery |
read
RESTful GET service
search-type
RESTful Search
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | string | Practitioner identifier, format <naming-system>|<value> |
SHALL | _id | string | Practitioner IPC, unique identifier |
SHALL | family | string | Practitioner family name |
SHALL | given | string | Practitioner given name |
SHALL | gender | string | Practitioner gender |
SHALL | address-city | string | Practitioner city |
SHALL | _has | string | PractitionerRole:practitioner:role= <role> |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $entityQuery | |
SHALL | $extendedQuery | FUTURE |
read
RESTful GET service
search-type
RESTful Search
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | string | Organization identifier, format <naming-system>|<value> |
SHALL | name | string | Organization name |
SHALL | type | string | Organization role type |
SHALL | address-city | string | Organization city |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $entityQuery | |
SHALL | $extendedQuery | FUTURE |
read
RESTful GET service
search-type
RESTful Search
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | string | Location identifier, format <naming-system>|<value> |
SHALL | address-city | string | Location city |
SHALL | address-line1 | string | Location city |
SHALL | otheraddress-line1 | string | Location city |
SHALL | healthServiceDeliveryArea | string | Location health Service Delivery Area |
SHALL | healthAuthority | string | Location health Authority |
SHALL | communityHealthServiceArea | string | Location community Health Service Area |
SHALL | localHealthArea | string | Location local Health Area |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $entityQuery | |
SHALL | $extendedQuery | FUTURE |
{ "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" } ] } ] }