The FHIR profiles used for the Assessment Scales Event Message Bundle
FHIR Profiles
The following FHIR profiles are used to form the Assessment Scales Event Message Bundle:
Bundle Structure
Specifies referencing within the Event Message Bundle.
Assessment Scales 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 |
CareConnect-Encounter-1.period.start |
Mandatory |
Format is YYYY-MM-DD”T”HH:MM:SS |
| ODS Site Code |
CareConnect-Location-1.identifier (ODS Site Code) |
Required |
|
| Professional Name |
CareConnect-Practitioner.name |
Required |
|
| SDS Job Role Name |
CareConnect-PractitionerRole-1.code (SDS Job Role Name) |
Required |
|
| Coded Assessment Tool Type (Total) |
CareConnect-Observation-1.code |
Mandatory |
This is the Assessment Scale Type. |
| Comment (Total Assessment Scale) |
CareConnect-Observation-1.comment |
Optional |
Supporting text may be given regarding the assessment scale as a whole. This could be the recording of a score of an assessment not in SNOMED CT (e.g. Griffiths). |
| Coded Assessment Tool Type Total Score |
CareConnect-Observation-1.value[x] |
Required |
Score entered for the Total Assessment Scale. |
| Coded Assessment Tool Type (Subscale) |
CareConnect-Observation-1.related.target.Observation.code |
Mandatory |
The type of Subscale Assessment Scale. Note, the Subscale may not always have a code, when the code is not available use code.text. |
| Comment (Subscale Assessment Scale) |
CareConnect-Observation-1.related.target.Observation.comment |
Optional |
Supporting text may be given regarding the assessment scale as a Subscale. This could be the recording of a Subscale score of an assessment not in SNOMED CT. |
| Coded Assessment Tool Type Subscale Score |
CareConnect-Observation-1.related.target.Observation.value[x] |
Required |
Score entered for the Subscale Assessment Scale. |
This is the recommended option to share Subscale Score.
For systems that hold the Coded Assessment Tool Type Total Score score, the Subscale scores and the associated observations:
- The overall Coded Assessment Tool Type Total Score score is held in the CareConnect-Observation-1 profile.
- The Subscale Assessment scores are held in the observation profile, contained within the CareConnect-Observation-1 profile. The CareConnect-Observation-1 profile links to each Subscale score profile using the related link.
- The observations are referenced by the Subscale scores using the related links.
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.
| Resource Cardinality |
1..1 |
| 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 |
| Element |
Cardinality |
Additional Guidance |
| extension(messageEventType) |
1..1 |
|
| event |
1..1 |
Fixed Value: “assessment-scales-1 | Assessment Scales” |
| 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. |
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 |
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 |
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 |
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 |
| 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 |
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 |
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:
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:
| 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 |
| PractitionerRole.code(keyWorkerStatus) |
0..1 |
If Practitioner is a key worker, PractitionerRole.codekeyWorkerStatus SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-KeyWorkerStatus-1 |
| PractitionerRole.specialty |
1..1 |
PractitionerRole.specialty SHALL use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-Specialty-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..* |
| Element |
Cardinality |
Additional Guidance |
| subject |
1..1 |
This will reference the patient resource representing the subject of this event |
| context |
1..1 |
This will reference the encounter resource representing the encounter at which the observation was made |
| performer |
1..1 |
This will reference the practitioner resource representing the practitioner making the observation |
| code |
1..1 |
code SHOULD use a value from https://fhir.nhs.uk/STU3/ValueSet/DCH-AssessmentScale-1 |
Assessment Scales Example
Profile Change Mappings for Assessment Scales
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-AssessmentScale-Observation-1 |
CareConnect-Observation-1 |
