The FHIR profiles used for the Newborn Hearing Event Message Bundle
Important: Newborn Hearing message revised after review and supplier feedback.
FHIR Profiles
The following FHIR profiles are used to form the Newborn Hearing Event Message Bundle:
Bundle Structure
Specifies referencing within the Event Message Bundle.
Newborn Hearing 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 |
Note |
| Date/Time |
CareConnect-Encounter-1.period.start |
Mandatory |
|
| Location (ODS Site Code) |
CareConnect-Location-1.identifier |
Required |
|
| Performing Professional |
CareConnect-Practitioner-1.name |
Required |
|
| SDS Job Role Name |
CareConnect-PractitionerRole-1.codeableConcept |
Required |
|
| Hearing Test Results (AABR) |
CareConnect-Procedure-1.outcome |
Required |
two occurrences of this resource are required, one for each ear |
| Hearing Test Result (AOAE) |
CareConnect-Procedure-1.outcome |
Required |
up to four occurrences of this resource are required, with two for each test performed |
| Summary Outcome |
CareConnect-Observation-1.valueCodeableConcept |
Mandatory |
|
| Comment |
CareConnect-Communication-1.payload.content[x] |
Optional |
|
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.
The Bundle resource included as part of the event message SHALL conform to the Bundle constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality |
1..1 Mandatory |
| Element |
Cardinality |
Additional Guidance |
| type |
1..1 |
Fixed value: message |
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 Mandatory |
| Element |
Cardinality |
Additional Guidance |
| id |
1..1 |
An originator/publisher unique publication reference, which will use a UUID format |
| extension(routingDemographics) |
1..1 |
The extension MUST contain the details of the patient who is the focus of this event message. |
extension(routingDemographics)
.extension(nhsNumber) |
1..1 |
The extension MUST contain the patient’s NHS Number identifier and is used by the NEMS for routing event messages to subscribers. |
extension(routingDemographics)
.extension(name) |
1..1 |
The extension MUST contain the human name element containing the patient’s official given and family names as recognised by PDS, and match the NHS number in the routingDemographics extension. |
extension(routingDemographics)
.extension(birthDateTime) |
1..1 |
The extension MUST contain the patient’s Date Of Birth which matches the NHS number in the routingDemographics extension. |
| meta.versionId |
0..1 |
Message Sequencing - A sequence number for the purpose of ordering messages for processing. The sequence number must be an integer which is patient and event-type specific and the publisher must increment the sequence number each time a new event of the same type is issued by the same system for the same patient. |
| meta.lastUpdated |
0..1 |
Message Sequencing - A FHIR instant (time stamp with sub-second accuracy) which represents the point in time that the change occurred which should be used for ordering messages for processing. |
| extension(eventMessageType) |
1..1 |
|
| event |
1..1 |
Fixed Value: newborn-hearing-1 (Newborn Hearing) |
| source |
1..1 |
The IT system which holds the information that originated the event |
| source.name |
1..1 |
A human readable name for the IT system which holds the information that originated the event |
| source.contact |
1..1 |
The email address or telephone number to be used by subscribers to contact the publisher for any issues with event message. Additional requirements and information available on the Event Feedback Mechanism page |
| source.contact.system |
1..1 |
Must contain a value of phone or email matching the included contact method within the value element |
| source.contact.value |
1..1 |
A phone number or email address |
| responsible |
1..1 |
A reference to the organization resource which represents the organization responsible for the event. |
| focus |
1..1 |
The focus element will reference the CareConnect-Encounter-1 resource which contains information relating to the event message. |
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..* Mandatory |
| 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 |
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 |
0..1 Required |
| 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 |
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 Mandatory |
| Element |
Cardinality |
Additional Guidance |
| 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 |
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 Mandatory |
| 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) |
0..1 |
Encounter.reason.coding(snomedCT) SHOULD 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 |
0..1 Required |
This will reference the Encounter’s Location |
| subject |
1..1 |
This will reference the patient resource representing the subject of this event |
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 Required |
The CareConnect-Practitioner-1 resource included as part of the event message SHALL conform to the CareConnect-Practitioner-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality |
0..1 Required |
The CareConnect-PractitionerRole-1 resource included as part of the event message SHALL conform to the CareConnect-PractitionerRole-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality |
0..1 Required |
| Element |
Cardinality |
Additional Guidance |
| organization |
1..1 |
This will reference the Organization resource responsible for the event |
| practitioner |
1..1 |
This will reference the Practitioner resource responsible for the event |
| PractitionerRole.code(careProfessionalType) |
1..1 |
PractitionerRole.code(careProfessionalType) SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-ProfessionalType-1 |
The CareConnect-Procedure-1 resource included as part of the event message SHALL conform to the CareConnect-Procedure-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality |
0..6 Required |
| Element |
Cardinality |
Additional Guidance |
| subject |
1..1 |
This will reference the patient resource representing the subject of this event |
For each of the Procedure resources representing a Test Outcome:
CareConnect-Procedure-1 (AABR Hearing Test)
| Element |
Cardinality |
Additional Guidance |
| Procedure.code.coding.system |
1..1 |
Fixed Value: http://snomed.info/sct |
| Procedure.code.coding.code |
1..1 |
Fixed Value: 413083006 |
| Procedure.code.coding.display |
1..1 |
Fixed Value: Automated auditory brainstem response test |
| Procedure.outcome.coding(snomedCT) |
1..1 |
Procedure.outcome.coding(snomedCT) SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-AABRHearingTest-Outcome-1 |
CareConnect-Procedure-1 (AOAE Hearing Test)
| Element |
Cardinality |
Additional Guidance |
| Procedure.code.coding.system |
1..1 |
Fixed Value: http://snomed.info/sct |
| Procedure.code.coding.code |
1..1 |
Fixed Value: 446077009 |
| Procedure.code.coding.display |
1..1 |
Fixed Value: Automated otoacoustic emission test |
| Procedure.outcome.coding(snomedCT) |
1..1 |
Procedure.outcome.coding(snomedCT) SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-AOAEHearingTest-Outcome-1 |
The CareConnect-Observation-1 resource included as part of the event message SHALL conform to the CareConnect-Observation-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality |
1..1 Mandatory |
| Element |
Cardinality |
Additional Guidance |
| subject |
1..1 |
The Hearing Screening Summary Outome observation will reference the patient resource. |
| Observation.valueCodeableConcept |
1..1 |
Observation.valueCodeableConcept SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-HearingScreeningOutcome-1 |
The CareConnect-Communication-1 resource included as part of the event message SHALL conform to the CareConnect-Communication-1 constrained FHIR profile and the additional population guidance as per the table below:
| Resource Cardinality |
0..1 Optional |
| Element |
Cardinality |
Additional Guidance |
| status |
1..1 |
Fixed value: completed |
| sender |
1..1 |
This will reference the sending organization of the event message. |
| subject |
1..1 |
This will reference the patient resource representing the patient who is the subject of this event. |
| Communication.category.coding.system |
1..1 |
Fixed Value: https://fhir.nhs.uk/STU3/CodeSystem/DCH-ProfessionalCommentType-1 |
| Communication.category.coding.code |
1..1 |
Fixed Value: 008 |
| Communication.category.coding.display |
1..1 |
Fixed Value: Newborn Hearing Screening |
DCH Newborn Hearing Example
Profile Change Mappings for Newborn Hearing
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 |
| CareConnect-DCH-Practitioner-1 |
CareConnect-Practitioner-1 |
| CareConnect-DCH-PractitionerRole-1 |
CareConnect-PractitionerRole-1 |
| CareConnect-DCH-AABRHearingTest-Procedure-1 |
CareConnect-Procedure-1 |
| CareConnect-DCH-AOAEHearingTest-Procedure-1 |
CareConnect-Procedure-1 |
| CareConnect-DCH-HearingScreeningSummaryOutcome-Observation-1 |
CareConnect-Observation-1 |
| DCH-ProfessionalComment-Communication-1 |
CareConnect-Communication-1 |
