FHIR Profiles
The following FHIR profiles are used to form the Additional Demographics Event Message Bundle:
- Bundle
- Event-MessageHeader-1 - where the coding and display elements for the ‘event’ type are fixed to ‘additional-demographics-1 | Additional Demographics’
- CareConnect-Organization-1
- CareConnect-HealthcareService-1
- CareConnect-Patient-1
- CareConnect-Encounter-1
- CareConnect-Location-1
Bundle Structure
Specifies mandatory referencing within the Event Message Bundle.
Additional Demographics Event data item mapping to FHIR profiles
This Mapping table defines the FHIR elements that SHALL be used to encode the Healthy Child Event Specification data items for each DCH Event Message payload.
Some common data item mappings, such as patient, publisher or Date/Time of event information, are defined within the Header mapping table and SHALL be considered in parallel with the payload mapping.
The Child Health Event data items are fulfilled by elements within the FHIR resources listed below:
| DCH Data Item | FHIR resource element | Mandatory/Required/Optional |
|---|---|---|
| Local Patient Identifier | CareConnect-Patient-1.identifier (localIdentifier) | Mandatory |
| Local Patient Identifier assigning Organisation | CareConnect-Patient-1.identifier(localIdentifier).assigner | Required |
| Town of Birth | CareConnect-Patient-1.birthPlace | Required |
| Country of Birth | CareConnect-Patient-1.birthPlace | Required |
| Patient email address | CareConnect-Patient-1.telecom.value | Required |
| Ethnicity see table below |
CareConnect-Patient-1.ethnicCategory | Required |
| Religion | CareConnect-Patient-1.religiousAffiliation | Required |
| Date and Time | CareConnect-Encounter-1.period.start | Required |
Ethnic categories mapping table
Ethnicity recording in Digital Child Health is requested to use the reduced 16+1 Ethnic Category list.
However, CareConnect-Patient-1 has a required binding to the CareConnect-EthnicCategory-1 valueset.
The following mapping SHOULD be used to map the ethnicCategory value to the reduced valueset.
| 16+1 valueSet | Mapping to PDS valueSet |
|---|---|
| A - British, Mixed British | A - British, Mixed British |
| B - Irish | B - Irish |
| C - Any Other White Background | C - Any other White background C2 - Northern Irish C3 - Other white, white unspecified CA - English CB - Scottish CC - Welsh CD - Cornish CE - Cypriot(part not stated) CF - Greek CG - Greek Cypriot CH - Turkish CJ - Turkish Cypriot CK - Italian CL - Irish Traveller CM - Traveller CN - Gypsy/Romany CP -Polish CQ - All republics which made up the former USSR CR - Kosovan CS - Albanian CT - Bosnian CU - Croatian CV - Serbian CW - Other republics which madeup the former Yugoslavia CX - Mixed white CY - Other white European, European unspecified, European mixed |
| D - White & Black Caribbean | D - White & Black Caribbean |
| E - White & Black African | E - White & Black African |
| F - White & Asian | F - White & Asian |
| G - Any Other Mixed Background | G - Any other mixed background GA - Black and Asian GB - Black and Chinese GC - Black and White GD - Chinese and White GE - Asian and Chinese GF - Other Mixed, Mixed Unspecified |
| H - Indian | H - Indian |
| J - Pakistani | J - Pakistani |
| K - Bangladeshi | K - Bangladeshi |
| L - Any Other Asian Background | LA - Mixed Asian LB - Punjabi LC - Kashmiri LD - East African Asian LE - Sri Lanka LF - Tamil LG - Sinhalese LH - British Asian LJ - Caribbean Asian LK - Other Asian, Asian unspecified |
| M - Caribbean | M - Caribbean |
| N - African | N - African |
| P - Any Other Black Background | P - Any other Black background PA - Somali PB - Mixed Black PC - Nigerian PD - Black British PE - Other Black, Black unspecified |
| R - Chinese | R - Chinese |
| S - Any Other Ethnic Group | S - Any other ethnic group SA - Vietnamese SB - Japanese SC - Filipino SD - Malaysian SE - Any Other Group |
| Z - Not Stated | Z - Not Stated |
Resource Population Requirements and Guidance
The following requirements and resource population guidance should be followed in addition to the requirements and guidance outlined in the data item mapping above and in the Event Header requirements page.
Bundle
| Resource Cardinality | 1..1 |
| Element | Cardinality | Additional Guidance |
|---|---|---|
| type | 1..1 | Fixed value: message |
Event-MessageHeader-1
The Event-MessageHeader-1 resource included as part of the event message SHALL conform to the Event-MessageHeader-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality | 1..1 |
| Element | Cardinality | Additional Guidance |
|---|---|---|
| extension(messageEventType) | 1..1 | |
| event | 1..1 | Fixed Value: additional-demographics-1 (Additional Demographics) |
| responsible | 1..1 | This will reference the responsible Organization resource |
| focus | 1..1 | This will reference the CareConnect-Encounter-1 resource which contains information relating to the event message. |
CareConnect-Organization-1
The CareConnect-Organization-1 resource included as part of the event message SHALL conform to the CareConnect-Organization-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality | 1..* |
| Element | Cardinality | Additional Guidance |
|---|---|---|
| identifier.system | 1..1 | Fixed value: https://fhir.nhs.uk/Id/ods-organization-code |
| identifier.value | 1..1 | Organisation’s ODS Organization Code |
| name | 1..1 | Organisation’s Name |
CareConnect-HealthcareService-1
The CareConnect-HealthcareService-1 resource included as part of the event message SHALL conform to the CareConnect-HealthcareService-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality | 1..1 |
| Element | Cardinality | Additional Guidance |
|---|---|---|
| providedBy | 1..1 | This will reference the ‘sender’ organization of the event message. |
| type | 1..1 | This will represent the type of service responsible for the event message. This will have a fixed value from the ValueSet CareConnect-CareSettingType-1 |
| specialty | 1..1 | HealthcareService.specialty SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-Specialty-1 |
CareConnect-Patient-1
The CareConnect-Patient-1 resource included as part of the event message SHALL conform to the CareConnect-Patient-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality | 1..1 |
| Element | Cardinality | Additional Guidance |
|---|---|---|
| identifier(localIdentifier) | 1..1 | Local Patient Identifier SHALL be included within the localIdentifier identifier slice |
| identifier(localIdentifier),assigner | 1..1 | This will reference the Local Patient Identifier assigning Organisation |
| identifier | 1..1 | Patient NHS Number SHALL be included within the nhsNumber identifier slice |
| name (official) | 1..1 | Patients name as registered on PDS, included within the resource as the official name element slice |
| birthDate | 1..1 | The patient birth date shall be included in the patient resource |
CareConnect-Encounter-1
The CareConnect-Encounter-1 resource included as part of the event message SHALL conform to the CareConnect-Encounter-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality | 1..1 |
| Element | Cardinality | Additional Guidance |
|---|---|---|
| Encounter.type.coding(childHealthEncounterType) | 1..1 | Encounter.type.coding(childHealthEncounterType) SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-ChildHealthEncounterType-1 |
| Encounter.reason.coding(snomedCT) | 1..1 | Encounter.reason.coding(snomedCT) SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-AdmissionReason-1 |
| serviceProvider | 1..1 | This will reference the Organisation resource hosting the Encounter |
| location | 1..1 | This will reference the Encounter’s Location |
| subject | 1..1 | This will reference the patient resource representing the subject of this event |
CareConnect-Location-1
The CareConnect-Location-1 resource included as part of the event message SHALL conform to the CareConnect-Location-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality | 0..1 |
DCH Additional Demographics Example
Profile Change Mappings for Additional Demographics
Profiles used in Demographics Update Event Messages 1.2.1-Release Candidate are replaced with:
| Demographic-Event-Messages | Demographic-Event-Messages-CareConnect |
|---|---|
| DCH-Bundle-1 | Bundle |
| DCH-MessageHeader-1 | Event-MessageHeader-1 |
| CareConnect-Organization-1 | CareConnect-Organization-1 |
| DCH-HealthcareService-1 | CareConnect-HealthcareService-1 |
| CareConnect-DCH-Patient-1 | CareConnect-Patient-1 |
| CareConnect-DCH-Encounter-1 | CareConnect-Encounter-1 |
| CareConnect-Location-1 | CareConnect-Location-1 |