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

FHIR IG Statistics: OperationDefinition/bc-patient-find-candidates

Packagefhir.ca-bc.client
Resource TypeOperationDefinition
Idbc-patient-find-candidates
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=fhir.ca-bc.client@1.0.1&canonical=http://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-find-candidates
URLhttp://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-find-candidates
Version1.0.0
Statusactive
Date2025-02-07T23:01:35+00:00
NameFindCandidatesByExample
TitleFind Candidates By Example
Realmus
Authorityhl7
DescriptionThis operation is used to query for a patient. The response can contain 0 or more Patients.
Typetrue
Kindquery

Resources that use this resource

CapabilityStatement
bc-hcim-capability-statement-serverBC HCIM Server Capability Statement

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition bc-patient-find-candidates

URL: [base]/Patient/$FindCandidates

Input parameters Profile:FindCandidatesRequestBundle

Output parameters Profile:SearchResponseBundle

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INFindCandidatesRequestBundle1..1Bundle

The FindCandidates operation request Bundle.

OUTSearchResponseBundle1..1Bundle

The FindCandidates operation response Bundle.


Source

{
  "resourceType": "OperationDefinition",
  "id": "bc-patient-find-candidates",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-find-candidates",
  "version": "1.0.0",
  "name": "FindCandidatesByExample",
  "title": "Find Candidates By Example",
  "status": "active",
  "kind": "query",
  "date": "2025-02-07T23:01:35+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 patient.  The response can contain 0 or more Patients.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CA",
          "display": "Canada"
        }
      ]
    }
  ],
  "code": "FindCandidates",
  "resource": [
    "Patient"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "inputProfile": "http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-find-candidates-request-bundle",
  "outputProfile": "http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-search-response-bundle",
  "parameter": [
    {
      "name": "FindCandidatesRequestBundle",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The FindCandidates operation request Bundle.",
      "type": "Bundle"
    },
    {
      "name": "SearchResponseBundle",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The FindCandidates operation response Bundle.",
      "type": "Bundle"
    }
  ]
}