From afb5318eb97477355329f46e1f21069e677706ae Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Mon, 27 Oct 2025 14:43:07 +0000 Subject: [PATCH 1/4] App6-Example-updates --- Examples/Questionnaire for PTS.xml | 88 +- ...e Request - CAD Out of Area C4(1 of 1).xml | 1008 +++++++++++++++++ 2 files changed, 1066 insertions(+), 30 deletions(-) create mode 100644 Examples/REFREQ10 - Referral Service Request - CAD Out of Area C4(1 of 1).xml diff --git a/Examples/Questionnaire for PTS.xml b/Examples/Questionnaire for PTS.xml index 9e61eb0c..1320f8aa 100644 --- a/Examples/Questionnaire for PTS.xml +++ b/Examples/Questionnaire for PTS.xml @@ -1,25 +1,25 @@ - + - - + + - + - - - - <status value="active" /> - <experimental value="false" /> - <date value="2023-12-19T14:00:00+00:00" /> - <publisher value="NHSE - BaRS" /> - <description value="PTS Questionnaire for CAD-to-CAD" /> + <version value="0.2"/> + <name value="PTS"/> + <title value="Pre Triage Sieve Questionnaire"/> + <status value="active"/> + <experimental value="false"/> + <date value="2025-10-27T11:00:00+00:00"/> + <publisher value="NHSE - BaRS"/> + <description value="PTS Questionnaire for CAD-to-CAD"/> <item> - <linkId value="0" /> - <text value="Is the patient breathing?" /> - <type value="choice" /> - <required value="true" /> + <linkId value="0"/> + <text value="Is the patient breathing?"/> + <type value="choice"/> + <required value="true"/> <answerOption> <valueCoding> <system value="http://snomed.info/sct"/> @@ -36,18 +36,18 @@ </answerOption> </item> <item> - <linkId value="1" /> - <text value="Is the patient awake (conscious)?" /> - <type value="choice" /> + <linkId value="1"/> + <text value="Is the patient awake (conscious)?"/> + <type value="choice"/> <enableWhen> - <question value="0" /> - <operator value="="/> + <question value="0"/> + <operator value="="/> <answerCoding> - <code value="78064003" /> - <display value="Breathing (observable entity)" /> + <code value="78064003"/> + <display value="Breathing (observable entity)"/> </answerCoding> </enableWhen> - <required value="false" /> + <required value="false"/> <answerOption> <valueCoding> <system value="http://snomed.info/sct"/> @@ -64,18 +64,18 @@ </answerOption> </item> <item> - <linkId value="2" /> - <text value="Is their breathing noisy?" /> - <type value="choice" /> + <linkId value="2"/> + <text value="Is their breathing noisy?"/> + <type value="choice"/> <enableWhen> - <question value="0" /> - <operator value="="/> + <question value="0"/> + <operator value="="/> <answerCoding> <code value="78064003"/> <display value="Breathing (observable entity)"/> </answerCoding> </enableWhen> - <required value="false" /> + <required value="false"/> <answerOption> <valueCoding> <system value="http://snomed.info/sct"/> @@ -91,4 +91,32 @@ </valueCoding> </answerOption> </item> + <item> + <linkId value="3"/> + <text value="Is their breathing effective?"/> + <type value="choice"/> + <enableWhen> + <question value="0"/> + <operator value="="/> + <answerCoding> + <code value="78064003"/> + <display value="Breathing (observable entity)"/> + </answerCoding> + </enableWhen> + <required value="false"/> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct"/> + <code value="230145002"/> + <display value="Difficulty breathing (finding)"/> + </valueCoding> + </answerOption> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct"/> + <code value="20716004"/> + <display value="Respiratory rate normal (finding)"/> + </valueCoding> + </answerOption> + </item> </Questionnaire> diff --git a/Examples/REFREQ10 - Referral Service Request - CAD Out of Area C4(1 of 1).xml b/Examples/REFREQ10 - Referral Service Request - CAD Out of Area C4(1 of 1).xml new file mode 100644 index 00000000..ef544e47 --- /dev/null +++ b/Examples/REFREQ10 - Referral Service Request - CAD Out of Area C4(1 of 1).xml @@ -0,0 +1,1008 @@ +<!-- This messages shows a scenario in 999 where a 3rd party calls 999 where a patient is in distress and requires a CAT4 ambulance + +This is Message 1 of 1. + +No follow up update messages expected. + + --> +<Bundle xmlns="http://hl7.org/fhir"> + <id value="146b45fc-30f3-4f8f-9cd9-6462db3ff0c4" /> + <meta> + <versionId value="1.0.0-beta" /> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage" /> + </meta> + <type value="message" /> + <timestamp value="2025-10-27T11:30:00+00:00" /> + <entry> + <!-- 0 --> + <fullUrl value="urn:uuid:47a4d16a-071c-440a-ba97-68716526ef6e" /> + <resource> + <MessageHeader> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-servicerequest-request" /> + </meta> + <extension url="https://fhir.nhs.uk/StructureDefinition/CDSSExtension"> + <extension url="RequesterCDSSsoftware"> + <valueString value="Pathways" /> + </extension> + <extension url="RequesterCDSSversion"> + <valueString value="30.2.0" /> + </extension> + </extension> + <eventCoding> + <system value="https://fhir.nhs.uk/CodeSystem/message-events-bars" /> + <code value="servicerequest-request" /> + </eventCoding> + <destination> + <endpoint value="https://fhir.nhs.uk/Id/dos-service-id|111111111" /> + <!-- Sender to populate with the system (of the DoS used) and Service Identity value --> + <receiver> + <!-- Organization --> + <reference value="urn:uuid:ed6edb24-7cc3-4847-bedd-cfa342be47bb" /> + </receiver> + </destination> + <sender> + <!-- Organization --> + <reference value="urn:uuid:e9a90910-40eb-451f-9621-6c6209d5c5f7" /> + </sender> + <source> + <name value="Emergency service" /> + <software value="Patient Manager" /> + <version value="1.7" /> + <contact> + <system value="phone" /> + <value value="+44 (0113) 123 4567" /> + </contact> + <endpoint value="https://fhir.nhs.uk/Id/dos-service-id|2222222222" /> + <!-- The Sender must populate the 'NHSD-Target-Identifier' header value a Receiver needs to populate in order to send a response to them via the BaRS API e.g. 'system value(URL):Service-TargetIdentifer' --> + </source> + <reason> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/message-reason-bars" /> + <code value="new" /> + </coding> + </reason> + <focus> + <!-- ServiceRequest --> + <reference value="urn:uuid:b0056de1-3c52-4ec5-84d9-e80e5bfd87ed" /> + </focus> + <definition value="https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral" /> + </MessageHeader> + </resource> + </entry> + <entry> + <!-- 1 --> + <fullUrl value="urn:uuid:b0056de1-3c52-4ec5-84d9-e80e5bfd87ed" /> + <resource> + <ServiceRequest> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be619" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.nhs.uk/StructureDefinition/BARSServiceRequest-request-referral" /> + </meta> + <basedOn> + <!-- Always CarePlan --> + <reference value="urn:uuid:6b5f7f75-77c7-4e3a-9855-ced66ae94301" /> + </basedOn> + <status value="active" /> + <!-- used to drive workflow e.g. cancel/remove --> + <intent value="plan" /> + <!-- required and always set to 'plan' --> + <category> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/message-category-servicerequest" /> + <code value="referral" /> + <!-- Important for driving workflow, determining the type of referral being requested --> + <display value="Transfer of Care" /> + </coding> + <coding> + <!-- Use case category --> + <system value="https://fhir.nhs.uk/CodeSystem/usecases-categories-bars" /> + <code value="a6t1" /> + <display value="CAD to CAD Out of Area Referral" /> + </coding> + </category> + <subject> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </subject> + <encounter> + <reference value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + </encounter> + <authoredOn value="2025-10-27T11:30:00+00:00" /> + <requester> + <!-- Sending Practitioner --> + <reference value="urn:uuid:c589f9f7-6c8d-4af5-ad5b-7365ee5d4343" /> + </requester> + <performer> + <!-- Receiving/performing Organization/HealthcareService --> + <reference value="urn:uuid:51561c40-26fb-45c1-8879-99397e8a60d5" /> + </performer> + <locationReference> + <!-- Incident Location --> + <reference value="urn:uuid:02722d80-ac23-460f-8492-c6736d4eb7d3" /> + </locationReference> + </ServiceRequest> + </resource> + </entry> + <entry> + <!-- 2 Call Receiving Trust --> + <fullUrl value="urn:uuid:51561c40-26fb-45c1-8879-99397e8a60d5" /> + <resource> + <HealthcareService> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be779" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="http://hl7.org/fhir/StructureDefinition/HealthcareService" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" /> + </meta> + <identifier> + <system value="http://fhir.nhs.uk/Id/dos-service-id" /> + <value value="111111111" /> + </identifier> + <active value="true" /> + <providedBy> + <reference value="urn:uuid:ed6edb24-7cc3-4847-bedd-cfa342be47bb" /> + </providedBy> + <name value="Ambulance Service Trust A" /> + </HealthcareService> + </resource> + </entry> + <entry> + <!-- 3 --> + <fullUrl value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + <resource> + <Encounter> <!-- Senders Encounter --> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be651" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" /> + </meta> + <identifier> + <system value="https://sender.url/Id/case-number" /> + <!-- Set by the sender who is passing the business case number value --> + <value value="sender1234" /> + </identifier> + <status value="finished" /> + <statusHistory> + <status value="planned" /> + <period> + <start value="2025-10-27T11:22:00+00:00" /> + </period> + </statusHistory> + <statusHistory> + <status value="arrived" /> + <period> + <start value="2025-10-27T11:23:00+00:00" /> + </period> + </statusHistory> + <statusHistory> + <status value="in-progress" /> + <period> + <start value="2025-10-27T11:25:00+00:00" /> + </period> + </statusHistory> + <class> + <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" /> + <code value="EMER" /> + <display value="emergency" /> + </class> + <subject> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </subject> + <episodeOfCare> + <!-- Resource reference to an EpisodeOfCare Journey ID --> + <reference value="EpisodeOfCare/d877b820-e72b-44d1-a627-195f54bfc606" /> + </episodeOfCare> + <period> + <start value="2025-10-27T11:30:00+00:00" /> + </period> + <location> + <!-- Incident Location --> + <location> + <reference value="urn:uuid:02722d80-ac23-460f-8492-c6736d4eb7d3" /> + </location> + <status value="active" /> + <!-- Location confirmed time --> + <period> + <start value="2025-10-27T11:30:00+00:00" /> + </period> + </location> + </Encounter> + </resource> + </entry> + <entry> + <!-- 4 --> + <fullUrl value="urn:uuid:6b5f7f75-77c7-4e3a-9855-ced66ae94301" /> + <resource> + <CarePlan> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be385" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan" /> + </meta> + <status value="active" /> + <intent value="plan" /> + <subject> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </subject> + <encounter> + <!-- Encounter --> + <reference value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + </encounter> + <period> + <start value="2025-10-27T11:30:00+00:00" /> + </period> + <author> + <!-- Practitioner Reference if clinical --> + <reference value="urn:uuid:c589f9f7-6c8d-4af5-ad5b-7365ee5d4343" /> + </author> + <activity> + <outcomeCodeableConcept> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/pathways-sd-codes" /> + <code value="SD4521" /> + <display value="AMB oxygen level concern" /> + </coding> + </outcomeCodeableConcept> + <outcomeCodeableConcept> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/pathways-sg-codes" /> + <code value="SG1131" /> + <display value="Nosebleeds without injury" /> + </coding> + </outcomeCodeableConcept> + <outcomeCodeableConcept> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/pathways-dx-codes" /> + <code value="Dx0128" /> + <display value="Non-emergency Ambulance Response (Category 4)" /> + </coding> + </outcomeCodeableConcept> + <outcomeCodeableConcept> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/arp-priority-codes" /> + <code value="C4" /> + <display value="Cat4 Emergency" /> + </coding> + </outcomeCodeableConcept> + <!-- Pathways assessment --> + <outcomeCodeableConcept> + <text value="CONSULTATION SUMMARY:/nAmbulance response not required/nReferral to another service required/nReferral to primary care or emergency treatment centre required/nIllness or other health problem/nEmergency treatment centre within 4hrs/nPATHWAYS ASSESSMENT:/nAn ambulance response was not required./nCoronavirus risk was not identified./nReferral to another service was required./nA referral to a primary care service or emergency treatment centre was required./nAn illness or other health problem was the reason for referral./nPathway Selected: PW818, Nosebleeds without Injury/nReferral to an emergency treatment centre within 4 hours was required./nADVICE GIVEN:/nIf there are any new symptoms, or if the condition gets worse, changes or you have any other concerns, call us/nback./nRemember to take a list of any current medications if you go to the out of hours surgery./nNO INSTRUCTIONS GIVEN AS CALL RELATES TO AN INDIVIDUAL WHO HAS DIED./nNO INSTRUCTIONS GIVEN AS CALL IS BEING WARM TRANSFERRED (INTERIM CARE ADVICE MUST BE GIVEN IF THE CALL IS PLACED ON A QUEUE)" /> + </outcomeCodeableConcept> + <outcomeCodeableConcept> + <text value="Pre-Triage Sieve, Patient breathing, Patient conscious, NOT noisy breathing, No NOC - Proceed to Triage" /> + </outcomeCodeableConcept> + </activity> + </CarePlan> + </resource> + </entry> + <entry> + <!-- 5 --> + <fullUrl value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + <resource> + <Patient> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be274" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" /> + </meta> + <identifier> + <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"> + <valueCodeableConcept> + <coding> + <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" /> + <code value="number-present-and-verified" /> + <display value="Number present and verified" /> + </coding> + </valueCodeableConcept> + </extension> + <system value="https://fhir.nhs.uk/Id/nhs-number" /> + <value value="7778521234" /> + </identifier> + <name> + <use value="official" /> + <text value="Mrs Julie Grayson" /> + <family value="Grayson" /> + <given value="Julie" /> + <prefix value="Mrs" /> + </name> + <gender value="female" /> + <birthDate value="1990-09-04" /> + <address> + <use value="home" /> + <type value="both" /> + <text value="22 Brightside Crescent, Overtown, West Yorkshire, LS10 4YU" /> + <line value="22 Brightside Crescent" /> + <line value="Overtown" /> + <line value="Leeds" /> + <line value="West Yorkshire" /> + <city value="Overtown" /> + <district value="West Yorkshire" /> + <postalCode value="LS10 4YU" /> + </address> + <contact> + <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"> + <valuePositiveInt value="2" /> + </extension> + <relationship> + <coding> + <!-- patient --> + <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" /> + <code value="ONESELF" /> + <display value="self" /> + </coding> + </relationship> + <telecom> + <system value="phone" /> + <value value="01138698875" /> + <use value="home" /> + <rank value="2" /> + </telecom> + <telecom> + <system value="phone" /> + <value value="07736312544" /> + <use value="mobile" /> + <rank value="1" /> + </telecom> + </contact> + <contact> + <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"> + <valuePositiveInt value="1" /> + </extension> + <relationship> + <coding> + <!-- Emergency contact person --> + <system value="http://terminology.hl7.org/CodeSystem/v2-0131" /> + <code value="C" /> + <display value="Emergency Contact" /> + </coding> + </relationship> + <name> + <family value="Grayson" /> + <given value="Jack" /> + </name> + <telecom> + <system value="phone" /> + <value value="0789 1234999" /> + <use value="mobile" /> + <rank value="1" /> + </telecom> + <gender value="male" /> + </contact> + <communication> + <language> + <coding> + <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage" /> + <code value="en" /> + <display value="English" /> + </coding> + </language> + <preferred value="true" /> + </communication> + <generalPractitioner> + <reference value="urn:uuid:1a00de32-9f6d-49e3-b00c-f1fcd159253d" /> + </generalPractitioner> + </Patient> + </resource> + </entry> + <entry> + <!-- 6 Patient GP Org --> + <fullUrl value="urn:uuid:1a00de32-9f6d-49e3-b00c-f1fcd159253d" /> + <resource> + <Organization> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be123" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> + </meta> + <identifier> + <system value="https://fhir.nhs.uk/id/ods-organization-code" /> + <value value="G82077" /> + </identifier> + <name value="Patient's Surgery" /> + </Organization> + </resource> + </entry> + <entry> + <!-- 7 Patients GP - Role --> + <fullUrl value="urn:uuid:1e744e34-6bbb-4aa9-8b20-fa3bb91f9d8f" /> + <resource> + <PractitionerRole> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be111" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" /> + </meta> + <practitioner> + <reference value="urn:uuid:124450c0-d125-41a0-b951-ba1037c0594b" /> + </practitioner> + <organization> + <reference value="urn:uuid:1a00de32-9f6d-49e3-b00c-f1fcd159253d" /> + </organization> + <specialty> + <coding> + <system value="http://snomed.info/sct" /> + <code value="408443003" /> + <display value="General medical practice" /> + </coding> + </specialty> + </PractitionerRole> + </resource> + </entry> + <entry> + <!-- 8 Patients GP --> + <fullUrl value="urn:uuid:124450c0-d125-41a0-b951-ba1037c0594b" /> + <resource> + <Practitioner> + <id value="3218ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> + </meta> + <identifier> + <system value="https://fhir.nhs.uk/Id/sds-role-profile-id" /> + <value value="G823964" /> + </identifier> + <name> + <family value="Smith" /> + <given value="George" /> + </name> + <telecom> + <system value="phone" /> + <value value="0205663666" /> + <use value="work" /> + </telecom> + </Practitioner> + </resource> + </entry> + <entry> + <!-- 9 Org of Practitioner taking the request --> + <fullUrl value="urn:uuid:631eec84-e8de-4f04-8b5b-e9996fa24c1a" /> + <resource> + <Organization> + <id value="1238ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> + </meta> + <name value="Practitioner Org" /> + </Organization> + </resource> + </entry> + <entry> + <!-- 10 Receiver Org --> + <fullUrl value="urn:uuid:ed6edb24-7cc3-4847-bedd-cfa342be47bb" /> + <resource> + <Organization> + <id value="6758ec8e-0602-4d02-af8a-7b3cb72be614" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> + </meta> + <name value="Receiver Organization" /> + </Organization> + </resource> + </entry> + <entry> + <!-- 11 Sender Organisation --> + <fullUrl value="urn:uuid:e9a90910-40eb-451f-9621-6c6209d5c5f7" /> + <resource> + <Organization> + <id value="5558ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> + </meta> + <identifier> + <system value="https://fhir.nhs.uk/id/ods-organization-code" /> + <value value="RND" /> + </identifier> + <name value="Sender Organization" /> + </Organization> + </resource> + </entry> + <entry> + <!-- 12 Incident location --> + <fullUrl value="urn:uuid:02722d80-ac23-460f-8492-c6736d4eb7d3" /> + <resource> + <Location> + <id value="4448ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/BARSLocation-incident-location" /> + </meta> + <extension url="https://fhir.nhs.uk/StructureDefinition/LocationExtension"> + <extension url="UPRN"> + <valueString value="200002546857" /> + </extension> + <extension url="accuracy"> + <valueString value="80" /> + </extension> + </extension> + <name value="Newlands Medical Centre" /> + <type> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/location-types-bars" /> + <code value="ILOC" /> + <display value="Incident Location" /> + </coding> + </type> + <address> + <line value="Newlands Medical Centre" /> + <line value="315 Chorley New Road" /> + <line value="Greater Manchester" /> + <city value="Bolton" /> + <district value="Greater Manchester" /> + <postalCode value="BL1 5BP" /> + <country value="UK" /> + </address> + </Location> + </resource> + </entry> + <entry> + <!-- 13 Caller Location --> + <fullUrl value="urn:uuid:8eab64a7-839e-490e-83ba-5334368a04c8" /> + <resource> + <Location> + <id value="3338ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" /> + </meta> + <extension url="https://fhir.nhs.uk/StructureDefinition/LocationExtension"> + <extension url="UPRN"> + <valueString value="200002546857" /> + </extension> + </extension> + <name value="Newlands Medical Centre" /> + <type> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/location-types-bars" /> + <code value="CLOC" /> + <display value="Caller Location" /> + </coding> + </type> + <address> + <line value="Newlands Medical Centre" /> + <line value="315 Chorley New Road" /> + <line value="Greater Manchester" /> + <city value="Bolton" /> + <district value="Greater Manchester" /> + <postalCode value="BL1 5BP" /> + <country value="UK" /> + </address> + </Location> + </resource> + </entry> + <entry> + <!-- 14 Practitioner taking the request details --> + <fullUrl value="urn:uuid:c589f9f7-6c8d-4af5-ad5b-7365ee5d4343" /> + <resource> + <Practitioner> + <id value="2228ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> + </meta> + <identifier> + <system value="https://fhir.nhs.uk/Id/sds-role-profile-id" /> + <value value="PT2490" /> + </identifier> + <name> + <family value="TRUMAN" /> + <given value="John" /> + </name> + <telecom> + <system value="phone" /> + <value value="0205568345" /> + <use value="work" /> + </telecom> + </Practitioner> + </resource> + </entry> + <entry> + <!-- 15 --> + <fullUrl value="urn:uuid:c89af664-8a3e-48bd-bfea-57cd819f1205" /> + <resource> + <PractitionerRole> + <id value="1118ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" /> + </meta> + <practitioner> + <reference value="urn:uuid:c589f9f7-6c8d-4af5-ad5b-7365ee5d4343" /> + </practitioner> + <organization> + <reference value="urn:uuid:631eec84-e8de-4f04-8b5b-e9996fa24c1a" /> + </organization> + <code> + <!-- If populated then use SDS code --> + <coding> + <system value="http://snomed.info/sct" /> + <code value="224608005" /> + <display value="Administrative healthcare staff" /> + </coding> + </code> + <specialty> + <coding> + <system value="http://snomed.info/sct" /> + <code value="408443003" /> + <display value="General medical practice" /> + </coding> + </specialty> + </PractitionerRole> + </resource> + </entry> + <entry> + <!-- 16 --> + <fullUrl value="urn:uuid:e7b1df33-f0aa-4b91-a0a2-cf6360158680" /> + <resource> + <Condition> + <id value="4b816945-a51b-47c4-9efd-4d7f94c8e718" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" /> + </meta> + <clinicalStatus> + <coding> + <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" /> + <code value="active" /> + </coding> + </clinicalStatus> + <category> + <coding> + <system value="http://snomed.info/sct" /> + <code value="33962009" /> + <display value="Presenting complaint" /> + </coding> + </category> + <code> + <text value="Maternity Complications" /> + </code> + <subject> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </subject> + <encounter> + <reference value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + </encounter> + </Condition> + </resource> + </entry> + <entry> + <!-- 17 --> + <fullUrl value="urn:uuid:9c888050-9e7f-4b52-9662-77f160424b3d" /> + <!-- NOC QuestionnaireResponse WITHOUT linked (published) Questionnaire --> + <resource> + <QuestionnaireResponse> + <id value="8498ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" /> + </meta> + <extension url="http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason"> + <valueCodeableConcept> + <text value="Nature of Call (NOC)" /> + </valueCodeableConcept> + </extension> + <status value="completed" /> + <subject> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </subject> + <encounter> + <reference value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + </encounter> + <authored value="2025-10-27T11:30:00+00:00" /> + <author> + <reference value="urn:uuid:c589f9f7-6c8d-4af5-ad5b-7365ee5d4343" /> + </author> + <source> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </source> + <item> + <linkId value="0" /> + <text value="What is the nature of call??" /> + <answer> + <valueCoding> + <code value="MACM" /> + <display value="Maternity Complications" /> + </valueCoding> + </answer> + </item> + </QuestionnaireResponse> + </resource> + </entry> + <entry> + <fullUrl value="urn:uuid:3b0886eb-c3e0-4317-8780-5e5743b0553c" /> + <!-- 18 PTS Questions --> + <resource> + <Questionnaire> + <id value="9749ae76-28f7-4b8a-863f-aba64d19d678" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" /> + </meta> + <identifier> + <value value="76b4622b-2b8b-4f24-aee5-2631c7695594" /> + </identifier> + <version value="0.2"/> + <name value="PTS"/> + <title value="Pre Triage Sieve Questionnaire"/> + <status value="active"/> + <experimental value="false"/> + <date value="2025-10-27T11:00:00+00:00"/> + <publisher value="NHSE - BaRS" /> + <description value="PTS Questionnaire for CAD-to-CAD" /> + <item> + <linkId value="0" /> + <text value="Is the patient breathing?" /> + <type value="choice" /> + <required value="true" /> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="78064003" /> + <display value="Breathing (observable entity)" /> + </valueCoding> + </answerOption> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="1023001" /> + <display value="Not Breathing (finding)" /> + </valueCoding> + </answerOption> + </item> + <item> + <linkId value="1" /> + <text value="Is the patient awake (conscious)?" /> + <type value="choice" /> + <enableWhen> + <question value="0" /> + <operator value="=" /> + <answerCoding> + <code value="78064003" /> + <display value="Breathing (observable entity)" /> + </answerCoding> + </enableWhen> + <required value="false" /> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="428913001" /> + <display value="No loss of consciousness (situation)" /> + </valueCoding> + </answerOption> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="419045004" /> + <display value="Loss of consciousness (finding)" /> + </valueCoding> + </answerOption> + </item> + <item> + <linkId value="2" /> + <text value="Is their breathing noisy?" /> + <type value="choice" /> + <enableWhen> + <question value="0" /> + <operator value="=" /> + <answerCoding> + <code value="78064003" /> + <display value="Breathing (observable entity)" /> + </answerCoding> + </enableWhen> + <required value="false" /> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="248573009" /> + <display value="Noisy respiration (finding)" /> + </valueCoding> + </answerOption> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="48348007" /> + <display value="Normal breath sounds (finding)" /> + </valueCoding> + </answerOption> + </item> + <item> + <linkId value="3"/> + <text value="Is their breathing effective?"/> + <type value="choice"/> + <enableWhen> + <question value="0"/> + <operator value="="/> + <answerCoding> + <code value="78064003"/> + <display value="Breathing (observable entity)"/> + </answerCoding> + </enableWhen> + <required value="false"/> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct"/> + <code value="230145002"/> + <display value="Difficulty breathing (finding)"/> + </valueCoding> + </answerOption> + <answerOption> + <valueCoding> + <system value="http://snomed.info/sct"/> + <code value="20716004"/> + <display value="Respiratory rate normal (finding)"/> + </valueCoding> + </answerOption> + </item> + </Questionnaire> + </resource> + </entry> + <entry> + <fullUrl value="urn:uuid:ee8fd86c-1c50-4026-b565-d158f214341b" /> + <!-- 19 PTS Answers --> + <resource> + <QuestionnaireResponse> + <id value="9998ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" /> + </meta> + <extension url="http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason"> + <valueCodeableConcept> + <text value="Pre Triage Sieve Questionnaire" /> + </valueCodeableConcept> + </extension> + <questionnaire value="https://fhir.nhs.uk/Questionnaire/PTS" /> + <status value="completed" /> + <subject> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </subject> + <encounter> + <reference value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + </encounter> + <authored value="2025-10-27T11:30:00+00:00" /> + <author> + <reference value="urn:uuid:c589f9f7-6c8d-4af5-ad5b-7365ee5d4343" /> + </author> + <source> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </source> + <item> + <linkId value="0" /> + <text value="Is the patient breathing?" /> + <answer> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="78064003" /> + <display value="Breathing (observable entity)" /> + </valueCoding> + </answer> + </item> + <item> + <linkId value="1" /> + <text value="Is the patient awake (conscious)?" /> + <answer> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="428913001" /> + <display value="No loss of consciousness (situation)" /> + </valueCoding> + </answer> + </item> + <item> + <linkId value="2" /> + <text value="Is the patient breathing?" /> + <answer> + <valueCoding> + <system value="http://snomed.info/sct" /> + <code value="48348007" /> + <display value="Normal breath sounds (finding)" /> + </valueCoding> + </answer> + </item> + </QuestionnaireResponse> + </resource> + </entry> + <entry> + <fullUrl value="urn:uuid:73715b3c-fac7-4149-b09a-e7d2ec80d9d7" /> + <!-- 20 Scene Safety Flag --> + <resource> + <Flag> + <id value="d0f8ec8e-0602-4d02-af8a-7b3cb72be952" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="http://hl7.org/fhir/StructureDefinition/Flag" /> + <profile value="https://fhir.nhs.uk/StructureDefinition/BARSFlag-scene-safety" /> + </meta> + <status value="active" /> + <category> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/flag-categories-bars" /> + <code value="SS" /> + <display value="Scene Safety" /> + </coding> + </category> + <code> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/scene-safety-codes-bars" /> + <code value="S" /> + <display value="The Scene is safe" /> + </coding> + </code> + <subject> + <reference value="urn:uuid:02722d80-ac23-460f-8492-c6736d4eb7d3" /> + </subject> + <period> + <start value="2025-10-27T11:30:00+00:00" /> + </period> + <encounter> + <reference value="urn:uuid:9e87c45d-a9bb-417f-a6e0-344f4f83c1b7" /> + </encounter> + </Flag> + </resource> + </entry> + <entry> + <!-- 21 --> + <fullUrl value="urn:uuid:69b171b7-821e-4462-99fc-1e15e3f45354" /> + <resource> + <Communication> + <id value="d0f8ec8e-0602-4d02-af8a-7b3cb72be523" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Communication" /> + </meta> + <status value="completed" /> + <topic> + <text value="Response for recurrent and continuous nosebleeds with low oxygen" /> + </topic> + <sent value="2025-10-27T11:30:00.8185338+00:00" /> + <payload> + <contentString value="Patient in distress." /> + </payload> + </Communication> + </resource> + </entry> + <entry> + <!-- 22 --> + <fullUrl value="urn:uuid:ff720eaf-f8bd-4ad7-9fca-9b6b3408b65e" /> + <resource> + <Consent> + <id value="d0f8ec8e-0602-4d02-af8a-7b3cb72be722" /> + <meta> + <lastUpdated value="2025-10-27T11:30:00.8185338+00:00" /> + <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent" /> + </meta> + <status value="active" /> + <scope> + <coding> + <system value="http://terminology.hl7.org/CodeSystem/consentscope" /> + <code value="patient-privacy" /> + </coding> + </scope> + <category> + <coding> + <system value="https://fhir.nhs.uk/CodeSystem/consent-categories-bars" /> + <code value="DRC" /> + <display value="Direct Care" /> + </coding> + </category> + <patient> + <reference value="urn:uuid:2ef93178-0cc8-4a4c-bd4b-c2e6096ac957" /> + </patient> + <dateTime value="2025-10-27" /> + <policyRule> + <coding> + <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" /> + <code value="IMPLIED" /> + </coding> + </policyRule> + </Consent> + </resource> + </entry> +</Bundle> \ No newline at end of file From be476ccfc39ea9b25a8c4db60c28205c53e3a8a3 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Mon, 27 Oct 2025 15:51:31 +0000 Subject: [PATCH 2/4] App6-IG-Payload-updates-for-beta Payload amendments for QuestionnaireResponse to support NOC Questionnaire and QuestionnaireResponse payload descriptions updated --- .../BaRS-APP6/Payloads-for-Referrals.page.md | 36 +++++++++---------- .../BaRS-APP6/Referral-Payload.page.md | 4 +-- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Payloads-for-Referrals.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Payloads-for-Referrals.page.md index e670d99a..1692359a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Payloads-for-Referrals.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Payloads-for-Referrals.page.md @@ -143,7 +143,7 @@ The level of consent currently supported by BaRS is for 'Direct Care' only. In e ### Questionnaire A Questionnaire is an organised collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain. They may be simple flat lists of questions or can be hierarchically organised in groups and sub-groups, each containing questions. The Questionnaire defines the questions to be asked, how they are ordered and grouped, any intervening instructional text and what the constraints are on the allowed answers. The results of a Questionnaire can be communicated using the QuestionnaireResponse resource. -The Questionnaire resource is used to covey the Pre Triage Sieve and Nature of Call (NOC) questions and the potential responses as detailed below: +The Questionnaire resource is used to covey the Pre Triage Sieve and the potential responses as detailed below: #### Pre Triage Sieve | Question | Answer| Code | @@ -154,14 +154,30 @@ The Questionnaire resource is used to covey the Pre Triage Sieve and Nature of C | | No|419045004 Loss of consciousness| |Is their breathing noisy?| Yes| 248573009 Noisy respiration| | | No| 248573009 48348007 Normal breath sounds| +|Is their breathing effective?| Yes| 20716004 Respiratory rate normal (finding)| +| | No| 20716004 Difficulty breathing (finding)| This is an [example](https://simplifier.net/NHSBookingandReferrals/9749ae76-28f7-4b8a-863f-aba64d19d678/~json) of the Pre triage Sieve questionnaire. *Only the nationally agreed answers and associated codes in this table are valid to be sent. No locally defined responses can be sent.* +Nature of call (NOC) responses are not defined in a published Questionnaire but can be sent using a QuestionnaireResponse. See QuestionnaireResponse guidance. + +### Questionnaire Response +The Questionnaire Response resource is used to convey the PTS and NOC responses given by the patient (or their representative). + +The extension *questionnaireresponse-reason* **must** be populated to indicate which data is contained within, as outlined in the resource element guidance below. + +Using a nested set of *questionnaireResponse.item*, *questionnaireResponse.linkId* and *questionnaireResponse.answer* complex structured data can be generated and processed, by the Sender and Receiver, respectively. The element guidance for this resource below goes into detail but, essentially, the item and linkId can be continually nested to convey various types of information. The item indicates a new answer, linkId **may** correspond with the questionnaire question linkId, forging the relationship between the questionnaire and questionnaireResponse, and answer contains any the value recorded. The *questionnaireResponse.item.answer* datatype **must** correspond with that defined in the *questionnaire.item.answerOption*. + +We have published examples of [Pre Triage Sieve](https://simplifier.net/NHSBookingandReferrals/Examples-QuestionnaireResponse-for-PTS/~json) and [Nature of Call](https://simplifier.net/NHSBookingandReferrals/Examples-QuestionnaireResponse-for-NOC/~json) questionnaire responses. + +Pre Triage Sieve (PTS) responses will link directly to the associated published Questionnaire, while Nature of Call (NOC) responses are transfered in a QuestionnaireResponse without reference to a published Questionnaire. + #### Nature of Call (NOC) -Nature of call types are nationally agreed by ECPAG for ASTs using both AMPDS and NHS Pathways as their CDSS. Receivers **MUST** be able to process and display NOC types and their associated code for both NHS Pathways and AMPDS NOC types detailed below. +Nature of call types are nationally agreed by ECPAG for ASTs using both AMPDS and NHS Pathways as their CDSS. Receivers **MUST** be able to process and display NOC types and their associated code for both NHS Pathways and AMPDS NOC types detailed below, as well as locally agreed NOC codes. + ##### AMPDS NOC Types | Question | Answer (NOC type)| Code | @@ -181,11 +197,9 @@ Nature of call types are nationally agreed by ECPAG for ASTs using both AMPDS an This is an [example](https://simplifier.net/NHSBookingandReferrals/81599e54-c713-4f3e-bca9-90225657f18d/~json) of the Nature of Call questionnaire. -*Only the nationally agreed answers and associated codes in this table are valid to be sent. No locally defined responses can be sent.* ##### NHS Pathways NOC Types - | Question | Answer (NOC type) | Code | | -------------------------| ------| -------| |What is the Nature of Call?| Anaphylaxis| ANAP| @@ -203,20 +217,6 @@ This is an [example](https://simplifier.net/NHSBookingandReferrals/81599e54-c713 This is an [example](https://simplifier.net/NHSBookingandReferrals/81599e54-c713-4f3e-bca9-90225657f18d/~json) of the Nature of Call questionnaire. -*Only the nationally agreed answers and associated codes in this table are valid to be sent. No locally defined responses can be sent.* - - - -### Questionnaire Response -The Questionnaire Response resource is used to convey the PTS and NOC responses given by the patient (or their representative). - -The extension *questionnaireresponse-reason* **must** be populated to indicate which data is contained within, as outlined in the resource element guidance below. - -Using a nested set of *questionnaireResponse.item*, *questionnaireResponse.linkId* and *questionnaireResponse.answer* complex structured data can be generated and processed, by the Sender and Receiver, respectively. The element guidance for this resource below goes into detail but, essentially, the item and linkId can be continually nested to convey various types of information, as guided by the corresponding questionnaire. The item indicates a new answer, linkId **must** correspond with the questionnaire question linkId, forging the relationship between the questionnaire and questionnaireResponse, and answer contains any the value recorded. The *questionnaireResponse.item.answer* datatype **must** correspond with that defined in the *questionnaire.item.answerOption*. - -We have published examples of [Pre Triage Sieve](https://simplifier.net/NHSBookingandReferrals/Examples-QuestionnaireResponse-for-PTS/~json) and [Nature of Call](https://simplifier.net/NHSBookingandReferrals/Examples-QuestionnaireResponse-for-NOC/~json) questionnaire responses. - -*Only the nationally agreed answers and associated codes in the associated Questionnaire are valid to be sent in the QuestionnaireResponse.* ### Condition diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md index 93188b30..d844892c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Referral-Payload.page.md @@ -873,8 +873,8 @@ This payload is used to transmit all the necessary information that is required | QuestionnaireResponse.extension | | MUST | 0..* | | | QuestionnaireResponse.extension.url | This MUST be populated with Structure Definition 'http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason' - FIXED VALUE | MUST | 1..1 | http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason | | QuestionnaireResponse.extension.valueCodeableConcept | | MUST | 0..* | | -| QuestionnaireResponse.extension.valueCodeableConcept.text | This SHOULD be populated with the name of the questionnaire responses contained within | SHOULD | 0..1 | Pre Triage Sieve | -| QuestionnaireResponse.questionnaire | This MUST be populated with the Canonical value of the Questionnaire resource the responses relate to | MUST | 0..1 | https://fhir.nhs.uk/Questionnaire/NOC | +| QuestionnaireResponse.extension.valueCodeableConcept.text | This SHOULD be populated with the name of the questionnaire responses contained within. For the Nature-of-call response this MUST be set to 'Nature of Call (NOC)' | SHOULD | 0..1 | Pre Triage Sieve | +| QuestionnaireResponse.questionnaire | This MUST be populated with the Canonical value of the Questionnaire resource the responses relate to | MAY | 0..1 | https://fhir.nhs.uk/Questionnaire/PTS | | QuestionnaireResponse.status | This MUST be populated with 'completed' - Fixed Value | MUST | 1..1 | completed | | QuestionnaireResponse.subject | Follow UK Core guidance for populating this element | MUST | 0..1 | | | QuestionnaireResponse.subject.reference | This SHOULD be populated with a Reference to the Patient resource | MUST | 0..1 | urn:uuid:41e591ab-d333-4fb8-87b4-d35f740b6bfc | From e54cab770d35558c5b36e2ccfa47d74959abdb24 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Mon, 27 Oct 2025 16:05:03 +0000 Subject: [PATCH 3/4] Release Note updates Core App6 App4 --- .../Technical-Release-Notes/BaRS-Core/1.3.0.page.md | 5 +++++ .../Releases/Technical-Release-Notes/BaRS-Core/toc.yaml | 2 ++ .../Technical-Release-Notes/TRN-APP4/2.0.0.page.md | 8 ++++++-- .../Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md | 4 ++++ 4 files changed, 17 insertions(+), 2 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md index 5dbf98b6..c031d7e1 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md @@ -2,6 +2,9 @@ topic: TRN-Core-1.3.0 --- +<div class="bars-blg-expander"> +<div class="bars-blg-expander-entry" id="v1.3.0"> + ## {{page-title}} | Change | Description | Impact | @@ -14,6 +17,8 @@ topic: TRN-Core-1.3.0 | Standard Pattern Cancellation updated | Standard Pattern Cancellation updated to reference the new Find Resource Standard Pattern | <mark style="background-color: Green">Non-breaking</mark> | | Appointment Foundation updated | Appointment Foundation updated to reference the new Find Resource Standard Pattern | <mark style="background-color: Green">Non-breaking</mark> | +</div> +</div> <br> <hr> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml index 992406c8..c4319218 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml @@ -1,5 +1,7 @@ - name: Index filename: Index.page.md +- name: 1.3.1 + filename: 1.3.1.page.md - name: 1.3.0 filename: 1.3.0.page.md - name: 1.0.7 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP4/2.0.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP4/2.0.0.page.md index fc55201e..95bbe9bf 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP4/2.0.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP4/2.0.0.page.md @@ -16,8 +16,12 @@ This is a major release with a significant change to the Implementation Guidance | FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | |------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| -| Patient.identifier.extension.valueCodeableConcept.coding.code | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted. | Update | Referral Request |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | -| Patient.identifier.extension.valueCodeableConcept.coding.display | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted. | Update | Referral Request |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | +| Patient.identifier.extension.valueCodeableConcept.coding.code | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted. | Update | Validation Request |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | +| Patient.identifier.extension.valueCodeableConcept.coding.display | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted. | Update | Validation Request |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | +| Patient.identifier.extension.valueCodeableConcept.coding.code | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted. | Update | Intermin Validation Response |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | +| Patient.identifier.extension.valueCodeableConcept.coding.display | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted. | Update | Intermin Validation Response |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | +| Patient.identifier.extension.valueCodeableConcept.coding.code | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted. | Update | Full Validation Response |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | +| Patient.identifier.extension.valueCodeableConcept.coding.display | Follow UK Core guidance for populating this element | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted. | Update | Full Validation Response |Accommodate NHS No. Requirement | <mark style="background-color: Red">breaking</mark> | <br> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md index fd54d14c..66dfcebe 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.6.page.md @@ -12,6 +12,7 @@ This is a minor "patch" with clarifications to limited areas of the Implementati | | FHIR BaRS CodeSystem values added for Location Types | Values for Helimed From and Helimed To added | <mark style="background-color: LightGreen">non-breaking</mark> | | FHIR BaRS CodeSystem value added for Flag Categories | Value for Call Warning added | <mark style="background-color: LightGreen">non-breaking</mark> | +| Updated FHIR Questionnaire and QuestionnaireResponse guidance | Guidance updated to reflect Nature of Call published Questionnaire being removed for beta | <mark style="background-color: LightGreen">non-breaking</mark> | ### Payload Change Log @@ -19,6 +20,9 @@ This is a minor "patch" with clarifications to limited areas of the Implementati | FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | |------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| | patient.identifier.system | | This SHOULD be populated with the namespace for the Identifier | Update | Referral Request |Implementation Guidance consistent across all applications | <mark style="background-color: Yellow">correction</mark> | +| QuestionnaireResponse.extension.valueCodeableConcept.text | This SHOULD be populated with the name of the questionnaire responses contained within. | This SHOULD be populated with the name of the questionnaire responses contained within. For the Nature-of-call response this MUST be set to 'Nature of Call (NOC)' | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> | +| QuestionnaireResponse.questionnaire | Example updated - https://fhir.nhs.uk/Questionnaire/NOC | Example updated - https://fhir.nhs.uk/Questionnaire/PTS | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> | +| QuestionnaireResponse.questionnaire | Necessity Updated - MUST | Necessity Updated - MAY | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> | <br> From 35276d11b917564b4f5696b587c5fe72af41f3b2 Mon Sep 17 00:00:00 2001 From: luci-davies <lucinda.davies5@nhs.net> Date: Mon, 27 Oct 2025 16:45:05 +0000 Subject: [PATCH 4/4] Bug fixes and content changes --- .../Releases/Current-Releases.page.md | 6 +++++- .../Applications/BaRS-APP1/Index.page.md | 4 ++-- .../Applications/BaRS-APP2/Index.page.md | 4 ++-- .../Applications/BaRS-APP3/Index.page.md | 4 ++-- .../Applications/BaRS-APP4/Index.page.md | 4 ++-- .../Applications/BaRS-APP5/Index.page.md | 14 ++++++++++---- .../Applications/BaRS-APP6/Index.page.md | 2 +- .../Applications/Index.page.md | 8 ++++++-- .../BaRS-Pre-releases/Index.page.md | 4 ++++ .../Connect-as-a-receiver.page.md | 19 +++++++++++++++---- .../BaRSEndpointCatalogue.md | 2 +- .../DirectoryOfServiceConfiguration.md | 2 +- .../Firewallexceptions.md | 2 +- 13 files changed, 52 insertions(+), 23 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md index 6b6975af..22f21922 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md @@ -11,7 +11,7 @@ Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11 {{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} {{pagelink:application3, text:BaRS-APP3}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}} {{pagelink:application4, text:BaRS-APP4}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}} -{{pagelink:application5, text:BaRS-APP5}} | 1.1.3 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}} +{{pagelink:application5, text:BaRS-APP5}} | 1.1.4 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}} {{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.6 | beta | | Current Release | 12/11/2025 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}} {{pagelink:application7, text:BaRS-APP7}} | 1.0.0-alpha.4 | alpha | | Current Release | 02/07/2025 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}} @@ -173,6 +173,10 @@ Table detailing active versions of the latest Applications in Production (or cur <td>Application 5 v1.1.3</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td> </tr> + <tr> + <td>Application 5 v1.1.4</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td> + </tr> <tr> <td>Application 6 v1.0.0-beta.6</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Index.page.md index 7e130353..d56cd154 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Index.page.md @@ -20,8 +20,8 @@ topic: Application1 <tbody> <tr> <td>Application 1 v2.0.0</td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</a></td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td> <td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td> </tr> </tbody> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Index.page.md index 948f826e..a95e53b8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Index.page.md @@ -21,8 +21,8 @@ topic: Application2 <tbody> <tr> <td>Application 2 v2.0.0</td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</a></td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td> <td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td> </tr> </tbody> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Index.page.md index 11949acc..7977cbc0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Index.page.md @@ -20,8 +20,8 @@ topic: Application3 <tbody> <tr> <td>Application 3 v2.0.0</td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</a></td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td> <td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td> </tr> </tbody> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Index.page.md index 2e6fd5ed..5dc5e2db 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Index.page.md @@ -18,8 +18,8 @@ topic: Application4 <tbody> <tr> <td>Application 4 v2.0.0</td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</a></td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td> <td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td> </tr> </tbody> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md index 2a046bc7..6e2ab0e5 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md @@ -17,9 +17,9 @@ topic: Application5 </thead> <tbody> <tr> - <td>Application 5 v1.1.3</td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.1.x</a></td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</td> + <td>Application 5 v1.1.4</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.1.x</a></td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td> <td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0" target="_blank">v1.1.0</a></td> </tr> </tbody> @@ -27,7 +27,13 @@ topic: Application5 </div> -Any suppliers building to this application (Application 5) must engage with NHS England's Pharmacy First/Digital Services for Integrated Care teams prior to building Application 5. + <div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important: Notice for suppliers</b> + <p> + Any suppliers building to this application (Application 5) must engage with NHS England's Pharmacy First/Digital Services for Integrated Care teams prior to building Application 5. + </p> + +</div> + ## Use Cases Supported diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md index dbe9473e..f770bb01 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md @@ -24,7 +24,7 @@ topic: Application6 <tr> <td>Application 6 v1.0.0-beta.6</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.1.x</a></td> - <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td> <td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0" target="_blank">v1.1.0</a></td> </tr> </tbody> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md index 1fda5652..51530c6b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md @@ -13,7 +13,7 @@ This page provides a catalogue of implementation guides that have been developed -These guides are designed to be used in conjunction with the documentation for {{pagelink:design-core-1.0.7}}. +These guides are designed to be used in conjunction with the documentation for {{pagelink:design-core-1.3.1}}. @@ -23,7 +23,7 @@ These guides are designed to be used in conjunction with the documentation for { | {{pagelink:application2, text: Booking and Referrals into UEC (Application 2)}} | <p>111 Online - ED <br>111 Online - UTC <br> S&R - ED <br> S&R - UTC <br> <p> | 2.0.0 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a> | <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a> | | {{pagelink:application3, text: Referral into UEC (Application 3)}} | <p>999-CAS Referral<br> | 2.0.0 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a> | <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a> | | {{pagelink:application4, text: Referral into UEC for Validation (Application 4)}} | <p>999-CAS Validation<br> <p>999 AST to Falls Lifting Service<br> <p>999 AST to Community Services <br> | 2.0.0 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a> | <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a> | -| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} | <p>Primary Care to Community Pharmacy (Pharmacy First)<br> <p>Primary Care to Pharmacy Contraception (Oral Contraception) <br> <p>Primary Care to Pharmacy Blood Pressure Check Service<br> | 1.1.3 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">v1.3.0</a> | {{pagelink:design-core-1.3.1, text:v1.3.0}} | +| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} | <p>Primary Care to Community Pharmacy (Pharmacy First)<br> <p>Primary Care to Pharmacy Contraception (Oral Contraception) <br> <p>Primary Care to Pharmacy Blood Pressure Check Service<br> | 1.1.4 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">v1.3.0</a> | {{pagelink:design-core-1.3.1, text:v1.3.0}} | <hr> @@ -174,6 +174,10 @@ Table detailing active versions of the latest Applications in Production (or cur <td>Application 5 v1.1.3</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td> </tr> + <tr> + <td>Application 5 v1.1.4</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td> + </tr> <tr> <td>Application 6 v1.0.0-beta.6</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md index 549e25c4..a2a604f8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md @@ -171,6 +171,10 @@ Table detailing active versions of the latest Applications in Production (or cur <td>Application 5 v1.1.3</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td> </tr> + <tr> + <td>Application 5 v1.1.4</td> + <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td> + </tr> <tr> <td>Application 6 v1.0.0-beta.6</td> <td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md index ea3ceb80..a413dd57 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md @@ -6,6 +6,9 @@ topic: Connect-as-a-receiver BaRS uses TLS-MA to communicate with Receiving endpoints. Receiving endpoints need a certificate under the NHS Root CA to facilitate TLS-MA. The receiver needs to follow these steps to access Integration (INT) and Production (PROD) environments. +<br> + + ### How to connect to the BaRS proxy as a Receiver: Step 1: Apply for your domain [apply for a new nhs.uk domain](https://digital.nhs.uk/services/networking-addressing/apply-for-an-nhs.uk-domain-for-websites-and-web-applications). You must complete Section 5: For website or application records visible on the public internet. @@ -22,13 +25,15 @@ Step 3: Create a Certificate Signing Request (*.csr). This is the file you will openssl genpkey -algorithm RSA -out private.key -aes256 ``` Create the *.csr, use the following command:</br> -**Note:** <small>_Generate the CSR with only the common name field populated, which must match the FQDN. All other fields can remain blank. The email field MUST be blank. Please note FQDNs MUST be in the .nhs.uk domain as we can only issue certificates in this domain._</small> + ``` openssl req -new -key private.key -out request.csr ``` - +**Note:** <small>_Generate the CSR with only the common name field populated, which must match the FQDN. All other fields can remain blank. The email field MUST be blank. Please note FQDNs MUST be in the .nhs.uk domain as we can only issue certificates in this domain._</small> Step 4: Send the .csr file to be signed by NHS England and get the client certificate. To do this, follow these environment specific steps: +<br> + #### Client certificate: Integration (INT) Step 1: Contact ITOC to make a [Combined endpoint and service registration request](https://digital.nhs.uk/services/path-to-live-environments/path-to-live-forms/combined-endpoint-and-service-registration-request) @@ -38,13 +43,16 @@ In the form: * Select Create/renew a certificate only (No endpoint) * Specify Integration environment * FQDN must match your domain and CN on the cert e.g. '**BaRS-INT-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**' -* In Additional comments/notes, state ‘BaRS’ certificate request -Add ‘N/A’ in the Party Key field because there is no relation to SDS endpoints +* In "Additional comments/notes" state ‘BaRS’ certificate request +*Add ‘N/A’ in the "Existing party key" field because there is no relation to SDS endpoints. Step 2: Receive certificate from ITOC Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue +<br> + + #### Client certificate: Production (PROD) **Production endpoints can only be requested when Solution Assurance issue the supplier with the Technical Conformance certificate** @@ -62,6 +70,9 @@ Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for Step 4: Make changes to your [firewall exceptions](https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Deploy/Technical-deployment\Firewallexceptions) to receive messages from the BaRS proxy. +<br> + + #### Installing and configuring your application to use the certificate Step 1: INT and PROD copy the cert text inlcuding `-----BEGIN CERTIFICATE` as the first line and `END CERTIFICATE-----` as the last. Save this text locally as a file called barsinreceiver.cer (change the name to suit). diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.md b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.md index 12e944fe..5ba4d947 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.md @@ -14,7 +14,7 @@ The BaRS Proxy uses the ServiceId in the HTTP Header to reference the BaRS Endpo * Obtain the service's URL endpoint details from the Receiving supplier or provider. The endpoint will need to be certified and meet the criteria for connection to the BaRS Proxy. More details are available in [Connecting as a receiver](https://simplifier.net/guide/nhsbookingandreferralstandard/Home\Build\Testing-and-Environments\Connect-as-a-receiver.page.md) -* Email bookingandreferralstandard@nhs.net with the serviceid and endpoint details. State the environment to be configured, INT or PROD, and include planned dates for testing. +* Email: <england.bookingandreferralstandard@nhs.net> with the ServiceId and endpoint details. State the environment to be configured, INT or PROD, and include planned dates for testing. **Note**: CareConnect configuration must be maintained alongside the BaRS configuration. This is so senders who are not yet BaRS compliant can still work with CareConnect and GP Connect. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/DirectoryOfServiceConfiguration.md b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/DirectoryOfServiceConfiguration.md index 7aeda3a1..d113f743 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/DirectoryOfServiceConfiguration.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/DirectoryOfServiceConfiguration.md @@ -1,6 +1,6 @@ ## {{page-title}} -If the Receiving provider operates within Urgent and Emergency Care (UEC), they are likely to have a UEC Directory of Services (DoS) entry. DoS leads must configure Service Providers who wish to use BaRS in the standard way, as the service dictates, but their DoS ServiceId will also need to exist in the BaRS Endpoint Catalogue. +Each service delivered by an Urgent and Emergency Care (UEC) provider has an entry in the UEC Directory of Services (DoS). DoS Leads will continue to configure new UEC providers and services in the DoS, issuing each service with a DoS ServiceID. If the provider is going to use receive BaRS messages, the DoS ServiceId will also need to exist in the BaRS Endpoint Catalogue. Find out more about the [Directory of Service](https://digital.nhs.uk/services/directory-of-services-dos#top) <br> diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md index 529cbc23..48726ed8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/Firewallexceptions.md @@ -1,6 +1,6 @@ ## {{page-title}} -BaRS receivers need to configure firewall exceptions for both Integration and Production environments. +BaRS receivers need to configure firewall exceptions for both Integration (INT) and Production (PROD) environments. Requests from the BaRS API Proxy will originate from: