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-add | Version: 1.0.0 | |||
| Draft as of 2024-05-03 | Computable Name: AddPatient | |||
This operation is used for newborns or to ‘force create’ a 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.
Add Patient is a FHIR Operation. ‘force create’ and newborn interactions can be done with Add Patient Operation.
When adding a newborn the child’s PHN is unknown (unassigned) and thus a RelatedPersion which identifies the mother is needed to process the request.
URL: [base]/Patient/$AddPatient
Input parameters Profile: AddRequestBundle
Output parameters Profile: AddResponseBundle
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | AddRequestBundle | 1..1 | Bundle | The AddPatient operation request Bundle. | ||
| OUT | AddResponseBundle | 1..1 | Bundle | The AddPatient operation response Bundle. |
To improve support for commercial off the shelf FHIR server products and to be conformant, the Client Registry offers an alternative Operation Resource structure. Instead of the request body being a Bundle (as described on this page) the user can optionally send in the same Bundle, but wrapped in a Parameters Resource. The Parameters Resource has a single parameter, name is operationBundle, and value is the Bundle Resource.
| Cardinality | Resource Type | Comment |
|---|---|---|
| 1..1 | MetadataParametersIn | See profile. |
| 1..1 | ClientRegistryPatient | See profile. |
| 0..1 | RelatedPerson | For mom’s PHN. |
| 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 profile here, Add Patient has no additional paramters.
Besides the mandatory parameters, see profile here, Add Patient has no additional out parameters.
The mother’s PHN may be required, if so the PHN is sent to the Client Registry via a RelatedPerson resource in the In Bundle for this request.
See Add Patient request example.
See Add Patient newborn request example.
See Add Patient response example.