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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The Capability Statement for Client Registry
| BC HCIM Client Capability Statement |
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. |
| BC HCIM Server Capability Statement |
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 server. |
The defined Operations
| AddPatient |
This operation is used for newborns or to ‘force create’ a patient. |
| Find Candidates By Example |
This operation is used to query for a patient. The response can contain 0 or more Patients. |
| GetDemographics |
This operation is used to query for a patient. The response can contain 0 or 1 Patient. |
| HistoryPatient |
This operation is used to return the historical attributes of a patient. |
| Merge Patient |
This operation is used to merge patients. |
| Patient Notification |
This operation is used notify a user that a patient’s record has changed. |
| Revise Patient |
This operation is used to revise a patient’s demographics. |
The BC Patient profile
| ClientRegistryPatient |
General constraints on the Patient resource for use in the BC Client Registry project. |
| PatientMerge |
General constraints on the Patient resource for use in the BC Client Registry project Merge Operation. |
Bundles that support Patient and Client Registry Operations - Request and Response
| AddRequestBundle |
A Bundle that is used in the Client Registry for Add Patient requests. |
| AddResponseBundle |
A Bundle that is used in the Client Registry response to Add Patient requests. |
| AsyncAckBundle |
A Bundle that is used for the ACK response to an aynchronous operation request. |
| FindCandidatesRequestBundle |
A Bundle that is used in the Find Candidates Operation request. |
| GetDemographicsRequestBundle |
A Bundle that is used in the Get Demographics Operation request. |
| MergeRequestBundle |
A Bundle that is used in the Client Registry for Add Patient requests. |
| MergeResponseBundle |
A Bundle that is used in the Client Registry response to Merge Patient requests. |
| ReviseRequestBundle |
A Bundle that is used in the Client Registry for Revise Patient requests. This is also used by Patient Notitifications. |
| ReviseResponseBundle |
A Bundle that is used in the Client Registry response to Revise Patient requests. |
| SearchResponseBundle |
A Bundle that is used in the Client Registry response to Find Candidates and Get Demographics queries. |
Artifacts associated with resources that support Patient and Client Registry Operations
| MetadataParametersAsync |
Parameters profile for BC meta data - async messages. |
| MetadataParametersIn |
Parameters profile for BC meta data - incoming messages. |
| MetadataParametersOut |
Parameters profile for BC meta data - outbound messages. |
A set of operation request examples
| AddNewbornByMumsPHN-Request |
Example of $Add request with Mother’s PHN. |
| AddPatient-Request |
Example of $Add Patient request with all data fields populated. |
| FindCandidates-Request |
Example of $FindCandidates request |
| FindNewbornByMumsPHN-Request |
Example of $FindCandidates request with Mother’s PHN. |
| GetDemographics-Request |
Example of $GetDemographics request |
| GetDemographics-withHistory-Request |
Example of $GetDemographics request with History |
| Merge-Only-Request |
Example of $Merge only request. |
| Merge-SSRI-Request |
Example of $Merge request with SSRI. |
| Merge-WithPayload-Request |
Example of $Merge with payload request. |
| Revise-withMaxData-Request |
Example of $Revise request with all data fields populated. |
A set of operation response examples
| AddPatient-Response |
Example of a $Add Patient Response message. |
| FindCandidates-Response |
Example of $FindCandidates response |
| FindNewbornByMumsPHN-Response |
Example of $FindCandidates response with Mother’s PHN. |
| GetDemographics-Response |
Example of $GetDemographics response |
| GetDemographics-withHistory-Response |
Example of $GetDemographics response with History |
| GetDemographics-withPHNInfo-Response |
Example of $GetDemographics response with PHN info. Only organization users with specific access will receive this data, to be used by the admin Webapp |
| Merge-Response |
Example of $Merge response. |
| Merge-WithPayload-Response |
Example of $Merge response with payload. |
| Revise-Async-ACK |
Example of an Asynchronous $Revise ACK message. |
| Revise-Response |
Example of a $Revise Patient Response message. |
Artifacts that support Subscription Operations
| HCIM Patient Change Distributions Topic |
This is the subscription topic used for subscribing to different change distributions. |
| HCIMPatientChangeSubscription |
Profile on subscription for HCIM Patient Changes |
| MetadataParametersSubscription |
Parameters profile for BC meta data when a subscription response is sent. |
| SubscriptionNotificationBundle |
A Bundle that is used in the Client Registry when sending subscription notifications. |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| Partial Update Patient |
This operation is used to update a patient’s demographics, applied to only specific Patient attributes. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| PartialPatientUpdate |
Patient profile used to update a Patient. |
| PartialUpdateRequestBundle |
A Bundle that is used in the Client Registry for Patient update requests. |
| PatientByExample |
Will get removed. General constraints on the Patient resource for use in the BC Client Registry project for queries. PatientByExample is a resource of the Client Registry FHIR implementation use only by Get Demographics and Find Candidates |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| A code the describes how a particular Patient attribute is to be changed |
A code the describes how a particular Patient attribute is to be changed. |
| BC Address Validation Status Code |
A code that represents the validation status of the address |
| BC Birth Date History |
This extension allows the Client Registry to include historical birth dates in a single Patient resource. |
| BC Business Dates |
The effective dates for the parent element. |
| BC Death Date History |
This extension allows the Client Registry to include historical death dates and flags in a single Patient resource. |
| BC Death Verified Flag |
The Patients death is verified and as recorded in the Client Registry as a flag. This also includes death verified flag history as required. |
| BC Death Verified Flag History |
This extension allows the Client Registry to include historical death flags in a single Patient resource. |
| BC Gender History |
This extension allows the Client Registry to include historical gender codes in a single Patient resource. |
| BC Gender Identity with business dates. |
Gender Identity with business dates. |
| BC Identifier Status |
Identifier status. |
| BC Merge Status Code |
A code that represents the Merge status of the Patient. |
| BC Multiple Birth History |
This extension allows the Client Registry to include historical multiple birth values in a single Patient resource. |
| BC SourceID and UserID |
Identifiers for the source and user that modified the specific element that this extension is on. |
These define sets of codes used by systems conforming to this implementation guide.
| BC Address Validation Value Set |
BC Address Validation value set used to describe the validation status of an address |
| BC Client Registry Patient Change Notification Events Value Set |
Codes used to indicate that type of patient changes that a subscriber is interested in receiving. |
| BC Contact Point System Value Set |
BC Contact Point System value set, sliced to meet BC constraints. |
| BC Contact Point Use Value Set |
BC Contact Point Use value set, sliced to meet BC constraints. |
| BC Identifier Status Value Set |
BC Identifier Status value set used to describe the status of an identifier. |
| BC Merge Status Value Set |
BC Merge Status value set used to describe the merge status of a Patient. |
| BC Name Use value set. |
BC Name Use value set, sliced to meet BC constraints. |
| BC Update Patient Operation Value Set |
A Value Set of allowed update operations. |
These define new code systems used by systems conforming to this implementation guide.
| BC Client Registry Address Validation Status Code |
Codes used to define the address validation status. |
| BC Client Registry Operation Outcome details code system |
BC Client Registry Operation Outcome details code system |
| BC Client Registry Patient Change Notification Events Code System |
Codes used to indicate that type of patient changes that a subscriber is interested in receiving. |
| BC Client Registry merge status. |
Codes used to describe the merge status. |
| BC Client registry identifier status code system |
BC Client registry identifier status code system. |
| BC Code System Of Allowed Update Operations |
BC Code System of allowed update patient operations. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Bundle-MergePatient-Request-Example |
Example of $MergePatient operation. |
| Bundle-MergePatient-Response-Example |
A sample MergePatient Operation response. |
| Bundle-UpdatePatient-Request-Example |
A sample UpdatePatient request. This example shows a Address update that replaces an existing address. |
| Bundle-UpdatePatient-Response-Example |
A sample UpdatePatient Operation response. |
| OperationOutcome-Example |
Example OperationOutcome for a Client Registry Add, Revise or Merge. |
| OperationOutcome-Search-Example |
Example OperationOutcome for a Client Registry Search |
| Parameters-MergePatient-Response-Example |
Example of Merge response Metadata parameters |
| Parameters-MergePatient-TwoNonSurvivors-Example |
Example of $MergePatient operation. |
| Parameters-UpdatePatient-Request-Example |
Example of Update response Metadata parameters |
| Parameters-UpdatePatient-Response-Example |
Example of Update response Metadata parameters |
| Patient-GetDemographics-Example |
Example of Patient for $GetDemographics operation response |
| Patient-MergePatient-Example |
Example of a merge patient Patient |
| Patient-UpdatePatient-Request-Example |
Patient example for a UpdatePatient operation that changes the Address. |
| SampleCompositeSubscriptionRequest |
Sample subscription request for Composite View events |