Event Composition
The FHIR Composition id is a powerful identifier and should only be accessible by approved government systems, such as those using health
or nationalId
JWT scopes. If you are proposing a new webhook in a feature request, consider the resourceType
that your service requires, based on the explanation of the FHIR resources in the rest of this page. You should not need to expose the composition id in your mediator if your client service doesnt require it.
Parameter | Sample value | Description |
---|---|---|
|
| The unique |
|
| The FHIR resource type associated with the target |
URL
You can request the composition payload via the OpenHIM core using an authentication token and Composition id
.
NOTE: If the webhook returned a different resourceType, you could do this:
Request headers
Composition payload
Key payload parameters
Parameter | Sample value | Description |
---|---|---|
|
| The unique |
|
| The customer facing OpenCRVS |
|
| The FHIR resource type associated. |
|
| An array of FHIR Composition sections that can be filtered by code to find the appropriate resource entry reference. |
The relevant birth registration composition section codes are:
Section | Code | Entry reference |
|
| The FHIR encounter is a resource encompassing the lifecycle of the event registration process |
|
| The FHIR patient resource for the child |
|
| The FHIR patient resource for the mother |
|
| The FHIR patient resource for the father |
|
| The FHIR patient resource for the informant - in case the child was registered by someone other than a parent such as a legal guardian, or a self-registration |
|
| An array of FHIR DocumentReference resources for all the uploaded supporting documents to validate the registration |
|
| An array of FHIR DocumentReference resources for all birth certificates generated and printed |
Last updated