| Package | fhir.ca-bc.provider |
| Resource Type | OperationDefinition |
| Id | bc-extended-organization-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-organization-query |
| URL | http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-organization-query |
| Version | 1.0.0 |
| Status | draft |
| Date | 2025-02-28T00:26:03+00:00 |
| Name | OrganizationExtendedQuery |
| Title | Query for an organization that returns associated resources - FUTURE |
| Realm | us |
| Authority | hl7 |
| Description | 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. |
| 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-organization-query
URL: [base]/Organization/$extendedQuery
URL: [base]/Organization/[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 | name | 0..1 | string (string) | Search for organizations with the specified name, mandatory if no identifier specified. May use trailing wildcards, e.g. Clinic* | ||
| IN | description | 0..1 | string (string) | Search for organizations with the specified description, mapping to BCOrganization.alias. May use trailing wildcards, e.g. Clinic* | ||
| IN | type | 0..1 | string (token) | Search for organizations with the specified role type code, mandatory if no identifier specified, mapping to Organization.type | ||
| IN | address-line1 | 0..1 | string (string) | Search will run on Physical address, then Mailing address if no match was found on. May use trailing wildcards | ||
| IN | address-city | 0..1 | string (string) | Search for organizations with the specified city. | ||
| 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 BCOrganizationBundle found by the search. |
FHIR{
"resourceType": "OperationDefinition",
"id": "bc-extended-organization-query",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://hlth.gov.bc.ca/fhir/provider/OperationDefinition/bc-extended-organization-query",
"version": "1.0.0",
"name": "OrganizationExtendedQuery",
"title": "Query for an organization 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 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.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CA",
"display": "Canada"
}
]
}
],
"code": "extendedQuery",
"resource": [
"Organization"
],
"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": "name",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Search for organizations with the specified name, mandatory if no identifier specified. May use trailing wildcards, e.g. Clinic*",
"type": "string",
"searchType": "string"
},
{
"name": "description",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Search for organizations with the specified description, mapping to BCOrganization.alias. May use trailing wildcards, e.g. Clinic*",
"type": "string",
"searchType": "string"
},
{
"name": "type",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Search for organizations with the specified role type code, mandatory if no identifier specified, mapping to Organization.type",
"type": "string",
"searchType": "token"
},
{
"name": "address-line1",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Search will run on Physical address, then Mailing address if no match was found on. May use trailing wildcards",
"type": "string",
"searchType": "string"
},
{
"name": "address-city",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Search for organizations with the specified city.",
"type": "string",
"searchType": "string"
},
{
"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 BCOrganizationBundle found by the search.",
"type": "Bundle"
}
]
}