BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
BC Client Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-get-demographics | Version: 1.0.0 | |||
| Active as of 2024-06-07 | Computable Name: GetDemographics | |||
This operation is used to query for a patient. The response can contain 0 or 1 Patient.
Note
This specification is currently published as a Draft Standard on the ministry GitHub and is not intended for implementation. Feedback is welcome but readers should understand that there is more work to be done in testing the profiles and operations defined in this guide. For more information, please see the Future Plans page in this guide.
The Get Demographics query is a FHIR Operation.
The request is a Bundle with Resources for search parameters and a Patient, i.e. ClientRegistryClient, to match against. The Patient resource must have an identifier for this search to succeed.
Please refer also to the Identifiers page to find more details regarding how to use Identifier in your query.
URL: [base]/Patient/$GetDemographics
Input parameters Profile:GetDemographicsRequestBundle
Output parameters Profile:SearchResponseBundle
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | GetDemographicsRequestBundle | 1..1 | Bundle | GetDemographics request Bundle. | ||
| OUT | SearchResponseBundle | 1..1 | Bundle | GetDemograponics response Bundle. |
The response may not include any Patients if none matched the criteria. If there are patients returned, the Bundle.entry.search.score (i.e. entry for the Patient resource) will contain the Client Registry score.
In the context of the Get Demographics request message, the Patient resource must not have both a resource id (Patient.id) and a identifier(Patient.identifier) in the same request. If they are both supplied the message will be rejected.
| Cardinality | Resource Type | Comment |
|---|---|---|
| 1..1 | MetadataParametersIn | See profile. |
| 0..1 | ClientRegistryPatient | See profile. |
| Cardinality | Resource Type | Comment |
|---|---|---|
| 1..1 | MetadataParametersOut | See profile. |
| 1,,1 | OperationOutcome | An OperationOutcome resource that has warnings and errors regarding the operation requested. |
| 0..1 | ClientRegistryPatient | See profile. |
Besides the two mandatory name-value pairs, see here, Get Demographics has two more, see below.
| Name | Type | Cardinality | Notes |
|---|---|---|---|
| identifiersOnly | boolean | 0..1 | Instruct the Client Registry to return Patient Identifiers only when true. If not present, defaults to false. |
| withHistory | boolean | 0..1 | Boolean flag to return Patient’s history. If missing, defaults to false. |
Besides the mandatory parameters, the request search parameters are echoed back in the MetadataParametersOut resource with a parameter named requestParameters (which is a MetadataParametersIn resource).
| Name | Type | Cardinality | Notes |
|---|---|---|---|
| requestParameters | MetadataParametersIn | 1..1 | The request parameters are echoed back.. |
See Get Demographics request example.
See Get Demographics response example.
See Get Demographics with history response example.
See Get Demographics with PHN info response example.