FHIR Profiles
The following FHIR profiles are used to form the Legal Information Event Message Bundle:
- Bundle
- Event-MessageHeader-1
- CareConnect-Organization-1 - where the coding and display elements for the ‘event’ type are fixed to “legal-information-1 | Legal Information”
- CareConnect-HealthcareService-1
- CareConnect-Patient-1
- CareConnect-Encounter-1
- CareConnect-Location-1
- CareConnect-Observation-1
Bundle Structure
Specifies referencing within the Event Message Bundle.
Legal Information 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 |
Notes |
---|---|---|---|
Date/Time | CareConnect-Encounter-1.period.start | Mandatory | |
Looked After Child Start Date | CareConnect-Observation-1.effectivePeriod.start | Required | The ‘Looked After Child’ Observation SHALL be SNOMED CT coded “764841000000100 | Looked after child” |
Looked After Child End Date | CareConnect-Observation-1.effectivePeriod.end | Required | |
Local Authority (LAC) | CareConnect-Organization-1.name | Required | |
Local Authority (LAC) ODS Site Code | CareConnect-Organization-1.identifier (oDSOrganizationCode) | Required | |
Local Authority (LAC) Office Hours Telephone | CareConnect-Organization-1.telecom | Required | |
Local Authority (LAC) Emergency Duty Team Telephone | CareConnect-Organization-1.contact.telecom | Required | Organization.contact.purpose.text SHALL be set to “Emergency Duty Team phone number” |
Child Protection Plan Start Date | CareConnect-Observation-1.effectivePeriod.start | Required | The ‘Child Protection Plan’ Observation SHALL be SNOMED CT coded “1064311000000109 | Child protection plan” |
Child Protection Plan End Date | CareConnect-Observation-1.effectivePeriod.end | Required | |
Local Authority (CPP) | CareConnect-Organization-1.name | Required | |
Local Authority (CPP) ODS Site Code | CareConnect-Organization-1.identifier (oDSOrganizationCode) | Required | |
Local Authority (CPP) Office Hours Telephone | CareConnect-Organization-1.telecom | Required | |
Local Authority (CPP) Emergency Duty Team Telephone | CareConnect-Organization-1.contact.telecom | Required | Organization.contact.purpose.text SHALL be set to “Emergency Duty Team phone number” |
LAC: Looked After Child
CPP: Child Protection Plan
ODS: Organisation Data Service
The fact that a Child is ‘Looked After’ or has a ‘Child Protection Plan’ are recorded on separate CareConnect-DCH-Observation-1 instances. These MAY be associated with separate Local Authoritoes, modelled as CareConnect-Organization-1 instances (although usually one Local Authority only is involved).
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: “legal-information-1 | Legal Information” |
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 | 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 |
CareConnect-Observation-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 | TBC |
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 context of this event |
Legal Information Example
Profile Change Mappings for Legal Information
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-Observation-1 | CareConnect-Observation-1 |