Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Blood Spot Sample Taken Event Message Bundle

The FHIR profiles used for the Blood Spot Sample Taken Event Message Bundle

FHIR Profiles

The following FHIR profiles are used to form the Blood Spot Sample Taken Event Message Bundle:

Bundle Structure

Specifies mandatory referencing within the Event Message Bundle.


Blood Spot Sample Taken (open in new TAB)

Blood Spot Sample Taken event data item mapping to FHIR profiles

The Child Health Event data items are fulfilled by elements within the FHIR resources listed below.

DCH Data ItemFHIR resource elementMandatory/
Required/
Optional
Note
Sample Taken DateCareConnect-Procedure-1.performedDateTimeMandatory
ODS Site CodeCareConnect-Location-1.identifier (ODS Site Code)Required
Professional NameCareConnect-Practitioner-1.nameRequired
SDS Job Role NameCareConnect-PractitionerRole-1.code (SDS Job Role Name)Required
Procedure Request DateCareConnect-ProcedureRequest-1.authoredOnMandatory

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

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
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: ​blood-spot-sample-taken-1 (Blood Spot Sample Taken)
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-Practitioner-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:

Resource Cardinality TBC

CareConnect-PractitionerRole-1

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 TBC
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

CareConnect-Procedure-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 TBC
Element Cardinality Additional Guidance
subject 1..1 This will reference the patient resource representing the subject of this event

CareConnect-ProcedureRequest-1

The CareConnect-ProcedureRequest-1 resource included as part of the event message SHALL conform to the CareConnect-ProcedureRequest-1 constrained FHIR profile and the additional population guidance as per the table below:

Resource Cardinality TBC
Element Cardinality Additional Guidance
patient 1..1 This will reference the patient resource representing the subject of this event

DCH Blood Spot Sample Taken Example

Profile Change Mappings for Blood Spot Sample Taken

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-NewbornBloodSpotSampleTaken-Procedure-1 CareConnect-Procedure-1
DCH-NewbornBloodSpotScreening-ProcedureRequest-1 CareConnect-ProcedureRequest-1

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated