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/CapabilityStatement/bc-hcim-capability-statement-client | Version: 1.0.0 | |||
| Draft as of 2021-11-18 | Computable Name: HCIMClientCapabilityStatement | |||
This capability statement describes the use cases that are supported by the BC FHIR implementation of the Client Registry when it is acting as a client. I.e. sending notifications.
Raw OpenAPI-Swagger Definition file | Download
This capability statement describes the use cases that are supported by the BC FHIR implementation of the Client Registry when acting as a client. I.e. when sending Patient change notifications.
A Patient change notification is accomplished by using Subscriptions. A client will register a Subscription with the Client Registry. When the Client Registry determines that a change to a Patient has occurred, it will notify all clients that have subscribed to changes of that specific type.
The outgoing response to the Subscription is a Bundle. The Bundle has two entries: One with MetadataParamtersIn for messageId, messageDate and sender, one for a ClientRegistryPatient (profile of Patient). The following table describes the request and the four parameters; all are mandatory. The Client Registry SHALL use the following IN parameters when sending a change notification.
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | ReviseRequestBundle | 1..1 | ReviseRequestBundle | A Bundle with the Patient change. | |
| OUT | Out is a 200 HTTP response code indicating the subscription response was recieved. |