Package | fhir.ca-bc.provider |
Resource Type | OperationDefinition |
Id | bc-extended-practitioner-query |
FHIR Version | R4 |
Source | https://simplifier.net/resolve?scope=fhir.ca-bc.provider@1.0.1&canonical=http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-practitioner-query |
URL | http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-practitioner-query |
Version | 1.0.0 |
Status | draft |
Date | 2025-02-28T00:26:03+00:00 |
Name | PractitionerExtendedQuery |
Title | Query for a Practitioner that returns associated resources - FUTURE |
Realm | us |
Authority | hl7 |
Description | 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. |
Type | true |
Kind | query |
CapabilityStatement | |
bc-plr-server-capability-statement | BC PLR Server Capability Statement |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition bc-extended-practitioner-query
URL: [base]/Practitioner/$extendedQuery
URL: [base]/Practitioner/[id]/$extendedQuery
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | identifier | 0..1 | string (string) | String, representing the full identifier value with system and value, e.g. identifier=[system]|[value] | ||
IN | family | 0..1 | string (string) | Search for practitioners with the specified surname. May use trailing wildcards, e.g. Smith* | ||
IN | given | 0..1 | string (string) | Search for practitioners with the specified given name. May use trailing wildcards, e.g. Ann* | ||
IN | status | 0..1 | string (token) | Search for practitioners with a license that has the specified status. | ||
IN | address-city | 0..1 | string (string) | Search for practitioners with an address that includes the given city. | ||
IN | gender | 0..1 | string (token) | Search for practitioners with the specified gender. | ||
IN | role | 0..1 | string (token) | Search for practitioners that have an associated PractitionerRole code with the specified value (e.g. MD or RN) | ||
IN | communication | 0..1 | string (token) | Search for practitioners who can communicate with the specified language code. May be a comma separated list of language codes, e.g. F01,E09. | ||
IN | expertise | 0..1 | string (token) | Search for practitioners with a qualification that matches the specified expertise. May be a comma separated list of expertise codes, e.g. AM53,K34. | ||
IN | status-reason | 0..1 | string (token) | Search for practitioners with a license that has the specified status reason. | ||
IN | withHistory | 0..1 | boolean | true or false, The withHistory parameter instructs PLR to search through historical records for matching attributes. Only the current data is returned. | ||
OUT | bundle | 1..1 | Bundle | The Response Bundle with the OperationOutcome and the list of BCPractitionerBundle found by the search. |
{ "resourceType": "OperationDefinition", "id": "bc-extended-practitioner-query", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "url": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-practitioner-query", "version": "1.0.0", "name": "PractitionerExtendedQuery", "title": "Query for a Practitioner that returns associated resources - FUTURE", "status": "draft", "kind": "query", "date": "2025-02-28T00:26:03+00:00", "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 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.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "CA", "display": "Canada" } ] } ], "code": "extendedQuery", "resource": [ "Practitioner" ], "system": false, "type": true, "instance": true, "parameter": [ { "name": "identifier", "use": "in", "min": 0, "max": "1", "documentation": "String, representing the full identifier value with system and value, e.g. identifier=[system]|[value]", "type": "string", "searchType": "string" }, { "name": "family", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with the specified surname. May use trailing wildcards, e.g. Smith*", "type": "string", "searchType": "string" }, { "name": "given", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with the specified given name. May use trailing wildcards, e.g. Ann*", "type": "string", "searchType": "string" }, { "name": "status", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with a license that has the specified status.", "type": "string", "searchType": "token" }, { "name": "address-city", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with an address that includes the given city.", "type": "string", "searchType": "string" }, { "name": "gender", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with the specified gender.", "type": "string", "searchType": "token" }, { "name": "role", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners that have an associated PractitionerRole code with the specified value (e.g. MD or RN)", "type": "string", "searchType": "token" }, { "name": "communication", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners who can communicate with the specified language code. May be a comma separated list of language codes, e.g. F01,E09.", "type": "string", "searchType": "token" }, { "name": "expertise", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with a qualification that matches the specified expertise. May be a comma separated list of expertise codes, e.g. AM53,K34.", "type": "string", "searchType": "token" }, { "name": "status-reason", "use": "in", "min": 0, "max": "1", "documentation": "Search for practitioners with a license that has the specified status reason.", "type": "string", "searchType": "token" }, { "name": "withHistory", "use": "in", "min": 0, "max": "1", "documentation": "true or false, The withHistory parameter instructs PLR to search through historical records for matching attributes. Only the current data is returned.", "type": "boolean" }, { "name": "bundle", "use": "out", "min": 1, "max": "1", "documentation": "The Response Bundle with the OperationOutcome and the list of BCPractitionerBundle found by the search.", "type": "Bundle" } ] }