From f01c9a27a7cca5a0dfc11cae5e8aba469ac4b9d7 Mon Sep 17 00:00:00 2001 From: Derek Dreyer <56388818+d-dreyer@users.noreply.github.com> Date: Mon, 21 Sep 2026 12:36:36 +0100 Subject: [PATCH] NBRS-4732 - Fix Broken External Links Fixed links to the versioned BaRS API specs that are no longer published. Fixed links to SNOMED and HIMSS. Fixed a broken link to an HL7 code system. Unresolved are the broken links to the UK Core Simplifier pages. --- Examples/Condition-Vomiting-Disorder.xml | 2 +- Examples/FLA01 - Flag - Rejected Services.xml | 2 +- Examples/FLA07 - ReSPECT.xml | 2 +- Examples/FLA08 - Clinically Vulnerable.xml | 2 +- Examples/FLA09 - Psychological.xml | 2 +- ...AG11 - Additional Patient Informantion.xml | 2 +- Examples/OBSV03 - BMI.xml | 2 +- Examples/OBSV03 - Blood Pressure.xml | 6 ++-- Examples/Questionnaire for PTS.xml | 16 +++++----- Examples/QuestionnaireResponse for PTS.xml | 6 ++-- ...l Service Request New Full - 111 to ED.xml | 24 +++++++------- ... Service Request New Full - 999 to CAS.xml | 6 ++-- ... to Community Pharmacy - Minor Illness.xml | 10 +++--- ...rral Service Request - CAD Out of Area.xml | 32 +++++++++---------- ...ervice Request - CAD Mutal Aid Request.xml | 30 ++++++++--------- ...ice Request New Full - GP to BP - ABPM.xml | 20 ++++++------ ...al Service Request New Full - GP to OC.xml | 26 +++++++-------- ...e Request - CAD Out of Area C4(1 of 1).xml | 30 ++++++++--------- ...uest - Internal broker - AandG To e-RS.xml | 12 +++---- ...- CAD Out of Area C1(1 of 4 - Initial).xml | 26 +++++++-------- ... - CAD Out of Area C1(2 of 4 - Update).xml | 26 +++++++-------- ... - CAD Out of Area C1(3 of 4 - Update).xml | 28 ++++++++-------- ... Out of Area C1(4 of 4 - Final Update).xml | 28 ++++++++-------- ...- CAD Out of Area C2(1 of 3 - Initial).xml | 24 +++++++------- ... - CAD Out of Area C2(2 of 3 - Update).xml | 26 +++++++-------- ... Out of Area C2(3 of 3 - Final Update).xml | 26 +++++++-------- ... - ED to 111 Safeguarding DNA Feedback.xml | 14 ++++---- ...ponse Short - CAD Mutual Aid Rejection.xml | 2 +- ...st Response - CAD Out of Area Response.xml | 2 +- ... Service for minor illness (procedure).xml | 2 +- ... Service Request New Full - 999 to CAS.xml | 8 ++--- ...pdate Full - 999 to CAS Lower Priority.xml | 8 ++--- ...ce Request New Full AMPDS - 999 to CAS.xml | 8 ++--- ...ledgment - CAS to 999 Planned (0 of 2).xml | 8 ++--- ...erim - CAS to 999 In-progress (1 of 2).xml | 4 +-- ...te Full - CAS to 999 Finished (2 of 2).xml | 6 ++-- ...esponse New Full - CAS to 999 Finished.xml | 6 ++-- ... to 999 Finished Inc New CADid Cat 1-2.xml | 4 +-- ...se Interim - Reject Validation Request.xml | 4 +-- ... Response - Falls to 999 Finished copy.xml | 6 ++-- ...Principles-for-Integration-systems.page.md | 2 +- .../Content-Negotiation/Mechanism.page.md | 2 +- .../Releases/Previous-Releases.page.md | 32 +++++++++---------- .../BaRS-APP1/Referral-Payload.page.md | 12 +++---- .../BaRS-APP2/Referral-Payload.page.md | 12 +++---- .../BaRS-APP3/Referral-Payload.page.md | 12 +++---- .../BaRS-APP4/Payloads-for-Responders.page.md | 2 +- .../Validation-Request-Payload.page.md | 12 +++---- .../Validation-Response-Payload.page.md | 12 +++---- .../BaRS-APP5/Referral-Payload.page.md | 22 ++++++------- .../BaRS-APP6/Referral-Payload.page.md | 24 +++++++------- .../BaRS-APP7/How-does-it-work.page.md | 2 +- .../Applications/BaRS-APP7/Index.page.md | 2 +- .../BaRS-APP8/Referral-Payload.page.md | 22 ++++++------- .../Applications/Index.page.md | 2 +- .../BaRS-Pre-releases/Index.page.md | 6 ++-- .../Environments.page.md | 2 +- .../Update-Existing-Booking.page.md | 4 +-- .../DocumentReference-Interface.page.md | 2 +- .../Update-Existing-Booking.page.md | 4 +-- .../DocumentReference-Interface.page.md | 2 +- .../Update-Existing-Booking.page.md | 4 +-- .../DocumentReference-Interface.page.md | 2 +- .../Update-Existing-Booking.page.md | 4 +-- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../DocumentReference-Interface.page.md | 2 +- .../Cancel-Booking.page.md | 4 +-- .../Initial-Booking.page.md | 8 ++--- .../Introduction.page.md | 22 ++++++------- .../Rebook-Methods.page.md | 16 +++++----- .../Update-Existing-Booking.page.md | 4 +-- .../DocumentReference-Interface.page.md | 2 +- .../End-to-end-workflow/BaRS-FHIR-API.page.md | 4 +-- .../End-to-end-workflow/HTTP-Header.page.md | 2 +- .../Interface.md | 2 +- .../Introduction.md | 2 +- .../Home/Core/1.3.0/Index.page.md | 4 +-- .../Cancellation.page.md | 2 +- .../Introduction.page.md | 2 +- .../Cancel-Booking.page.md | 6 ++-- .../Initial-Booking.page.md | 12 +++---- .../Introduction.page.md | 28 ++++++++-------- .../Rebook-Methods.page.md | 4 +-- .../Reschedule-Existing-Booking.page.md | 8 ++--- .../Update-Existing-Booking.page.md | 8 ++--- .../DocumentReference-Interface.page.md | 2 +- .../Receiver-DocumentReference.md | 14 ++++---- .../Sender-DocumentReference.md | 12 +++---- .../End-to-end-workflow/BaRS-FHIR-API.page.md | 4 +-- .../End-to-end-workflow/HTTP-Header.page.md | 2 +- .../Interface.md | 2 +- .../Introduction.md | 2 +- .../Home/Core/1.3.1/Index.page.md | 4 +-- .../Cancellation.page.md | 2 +- .../Introduction.page.md | 2 +- .../BaRSEndpointCatalogue.page.md | 2 +- 102 files changed, 452 insertions(+), 452 deletions(-) diff --git a/Examples/Condition-Vomiting-Disorder.xml b/Examples/Condition-Vomiting-Disorder.xml index 4a29dc91..bfa50e48 100644 --- a/Examples/Condition-Vomiting-Disorder.xml +++ b/Examples/Condition-Vomiting-Disorder.xml @@ -14,7 +14,7 @@ - + diff --git a/Examples/FLA01 - Flag - Rejected Services.xml b/Examples/FLA01 - Flag - Rejected Services.xml index 89cc9555..a112e26a 100644 --- a/Examples/FLA01 - Flag - Rejected Services.xml +++ b/Examples/FLA01 - Flag - Rejected Services.xml @@ -15,7 +15,7 @@ - + diff --git a/Examples/FLA07 - ReSPECT.xml b/Examples/FLA07 - ReSPECT.xml index 1c60caa7..dd73d2b6 100644 --- a/Examples/FLA07 - ReSPECT.xml +++ b/Examples/FLA07 - ReSPECT.xml @@ -15,7 +15,7 @@ - + diff --git a/Examples/FLA08 - Clinically Vulnerable.xml b/Examples/FLA08 - Clinically Vulnerable.xml index e16a84a4..5654ef83 100644 --- a/Examples/FLA08 - Clinically Vulnerable.xml +++ b/Examples/FLA08 - Clinically Vulnerable.xml @@ -15,7 +15,7 @@ - + diff --git a/Examples/FLA09 - Psychological.xml b/Examples/FLA09 - Psychological.xml index fc870559..49ffa1e3 100644 --- a/Examples/FLA09 - Psychological.xml +++ b/Examples/FLA09 - Psychological.xml @@ -15,7 +15,7 @@ - + diff --git a/Examples/FLAG11 - Additional Patient Informantion.xml b/Examples/FLAG11 - Additional Patient Informantion.xml index a86dc8a2..7a1f7017 100644 --- a/Examples/FLAG11 - Additional Patient Informantion.xml +++ b/Examples/FLAG11 - Additional Patient Informantion.xml @@ -15,7 +15,7 @@ - + diff --git a/Examples/OBSV03 - BMI.xml b/Examples/OBSV03 - BMI.xml index 500dc3b6..aa5e83a3 100644 --- a/Examples/OBSV03 - BMI.xml +++ b/Examples/OBSV03 - BMI.xml @@ -15,7 +15,7 @@ - + diff --git a/Examples/OBSV03 - Blood Pressure.xml b/Examples/OBSV03 - Blood Pressure.xml index 7912570c..d5fbf001 100644 --- a/Examples/OBSV03 - Blood Pressure.xml +++ b/Examples/OBSV03 - Blood Pressure.xml @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@ - + @@ -44,7 +44,7 @@ - + diff --git a/Examples/Questionnaire for PTS.xml b/Examples/Questionnaire for PTS.xml index d5d85199..c9f36903 100644 --- a/Examples/Questionnaire for PTS.xml +++ b/Examples/Questionnaire for PTS.xml @@ -22,14 +22,14 @@ - + - + @@ -50,14 +50,14 @@ - + - + @@ -78,14 +78,14 @@ - + - + @@ -106,14 +106,14 @@ - + - + diff --git a/Examples/QuestionnaireResponse for PTS.xml b/Examples/QuestionnaireResponse for PTS.xml index 02d4c07c..5c630d15 100644 --- a/Examples/QuestionnaireResponse for PTS.xml +++ b/Examples/QuestionnaireResponse for PTS.xml @@ -28,7 +28,7 @@ - + @@ -39,7 +39,7 @@ - + @@ -50,7 +50,7 @@ - + diff --git a/Examples/REFREQ01 - Referral Service Request New Full - 111 to ED.xml b/Examples/REFREQ01 - Referral Service Request New Full - 111 to ED.xml index 97703ca1..fc99ed51 100644 --- a/Examples/REFREQ01 - Referral Service Request New Full - 111 to ED.xml +++ b/Examples/REFREQ01 - Referral Service Request New Full - 111 to ED.xml @@ -396,7 +396,7 @@ - + @@ -528,14 +528,14 @@ - + - + @@ -554,7 +554,7 @@ - + @@ -576,7 +576,7 @@ - + @@ -592,28 +592,28 @@ - + - + - + - + @@ -656,7 +656,7 @@ - + @@ -677,7 +677,7 @@ - + @@ -776,7 +776,7 @@ - + diff --git a/Examples/REFREQ02 - Referral Service Request New Full - 999 to CAS.xml b/Examples/REFREQ02 - Referral Service Request New Full - 999 to CAS.xml index f94d91f4..34696963 100644 --- a/Examples/REFREQ02 - Referral Service Request New Full - 999 to CAS.xml +++ b/Examples/REFREQ02 - Referral Service Request New Full - 999 to CAS.xml @@ -391,7 +391,7 @@ - + @@ -555,14 +555,14 @@ - + - + diff --git a/Examples/REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness.xml b/Examples/REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness.xml index dcc810a5..be0e4ae1 100644 --- a/Examples/REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness.xml +++ b/Examples/REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness.xml @@ -193,7 +193,7 @@ - + @@ -226,7 +226,7 @@ - + @@ -390,7 +390,7 @@ - + @@ -522,14 +522,14 @@ - + - + diff --git a/Examples/REFREQ04 - Referral Service Request - CAD Out of Area.xml b/Examples/REFREQ04 - Referral Service Request - CAD Out of Area.xml index 28098d71..77bc21ac 100644 --- a/Examples/REFREQ04 - Referral Service Request - CAD Out of Area.xml +++ b/Examples/REFREQ04 - Referral Service Request - CAD Out of Area.xml @@ -438,7 +438,7 @@ - + @@ -664,14 +664,14 @@ - + - + @@ -690,7 +690,7 @@ - + @@ -715,7 +715,7 @@ - + @@ -750,7 +750,7 @@ - + @@ -1011,14 +1011,14 @@ - + - + @@ -1039,14 +1039,14 @@ - + - + @@ -1067,14 +1067,14 @@ - + - + @@ -1117,7 +1117,7 @@ - + @@ -1128,7 +1128,7 @@ - + @@ -1139,7 +1139,7 @@ - + @@ -1219,7 +1219,7 @@ - + diff --git a/Examples/REFREQ05 - Referral Service Request - CAD Mutal Aid Request.xml b/Examples/REFREQ05 - Referral Service Request - CAD Mutal Aid Request.xml index aca13558..389b0efa 100644 --- a/Examples/REFREQ05 - Referral Service Request - CAD Mutal Aid Request.xml +++ b/Examples/REFREQ05 - Referral Service Request - CAD Mutal Aid Request.xml @@ -431,7 +431,7 @@ - + @@ -652,14 +652,14 @@ - + - + @@ -678,7 +678,7 @@ - + @@ -703,7 +703,7 @@ - + @@ -738,7 +738,7 @@ - + @@ -999,14 +999,14 @@ - + - + @@ -1027,14 +1027,14 @@ - + - + @@ -1055,14 +1055,14 @@ - + - + @@ -1105,7 +1105,7 @@ - + @@ -1116,7 +1116,7 @@ - + @@ -1127,7 +1127,7 @@ - + diff --git a/Examples/REFREQ06 - Referral Service Request New Full - GP to BP - ABPM.xml b/Examples/REFREQ06 - Referral Service Request New Full - GP to BP - ABPM.xml index 617cfe8e..c5ecefd3 100644 --- a/Examples/REFREQ06 - Referral Service Request New Full - GP to BP - ABPM.xml +++ b/Examples/REFREQ06 - Referral Service Request New Full - GP to BP - ABPM.xml @@ -196,7 +196,7 @@ - + @@ -211,7 +211,7 @@ - + @@ -227,7 +227,7 @@ - + @@ -256,12 +256,12 @@ - + - + @@ -294,7 +294,7 @@ - + @@ -458,7 +458,7 @@ - + @@ -548,7 +548,7 @@ - + @@ -597,14 +597,14 @@ - + - + diff --git a/Examples/REFREQ07 - Referral Service Request New Full - GP to OC.xml b/Examples/REFREQ07 - Referral Service Request New Full - GP to OC.xml index a6af60ba..1c907c47 100644 --- a/Examples/REFREQ07 - Referral Service Request New Full - GP to OC.xml +++ b/Examples/REFREQ07 - Referral Service Request New Full - GP to OC.xml @@ -198,7 +198,7 @@ - + @@ -240,7 +240,7 @@ - + @@ -273,7 +273,7 @@ - + @@ -302,7 +302,7 @@ - + @@ -324,7 +324,7 @@ - + @@ -341,21 +341,21 @@ - + - + - + @@ -372,7 +372,7 @@ - + @@ -532,7 +532,7 @@ - + @@ -622,7 +622,7 @@ - + @@ -671,14 +671,14 @@ - + - + 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 index ef544e47..79456d98 100644 --- 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 @@ -423,7 +423,7 @@ No follow up update messages expected. - + @@ -622,14 +622,14 @@ No follow up update messages expected. - + - + @@ -655,7 +655,7 @@ No follow up update messages expected. - + @@ -743,14 +743,14 @@ No follow up update messages expected. - + - + @@ -771,14 +771,14 @@ No follow up update messages expected. - + - + @@ -799,14 +799,14 @@ No follow up update messages expected. - + - + @@ -827,14 +827,14 @@ No follow up update messages expected. - + - + @@ -878,7 +878,7 @@ No follow up update messages expected. - + @@ -889,7 +889,7 @@ No follow up update messages expected. - + @@ -900,7 +900,7 @@ No follow up update messages expected. - + diff --git a/Examples/REFREQ11 - Referral Service Request - Internal broker - AandG To e-RS.xml b/Examples/REFREQ11 - Referral Service Request - Internal broker - AandG To e-RS.xml index c34309bc..c5e4a87b 100644 --- a/Examples/REFREQ11 - Referral Service Request - Internal broker - AandG To e-RS.xml +++ b/Examples/REFREQ11 - Referral Service Request - Internal broker - AandG To e-RS.xml @@ -86,7 +86,7 @@ - + @@ -211,7 +211,7 @@ - + @@ -244,7 +244,7 @@ - + @@ -351,7 +351,7 @@ - + @@ -483,14 +483,14 @@ - + - + diff --git a/Examples/REFREQ8A - Referral Service Request - CAD Out of Area C1(1 of 4 - Initial).xml b/Examples/REFREQ8A - Referral Service Request - CAD Out of Area C1(1 of 4 - Initial).xml index 7624de75..ba41c64d 100644 --- a/Examples/REFREQ8A - Referral Service Request - CAD Out of Area C1(1 of 4 - Initial).xml +++ b/Examples/REFREQ8A - Referral Service Request - CAD Out of Area C1(1 of 4 - Initial).xml @@ -458,14 +458,14 @@ Message 1 - Intital Message - + - + @@ -485,7 +485,7 @@ Message 1 - Intital Message - + @@ -514,7 +514,7 @@ Message 1 - Intital Message - + @@ -773,14 +773,14 @@ Message 1 - Intital Message - + - + @@ -801,14 +801,14 @@ Message 1 - Intital Message - + - + @@ -829,14 +829,14 @@ Message 1 - Intital Message - + - + @@ -879,7 +879,7 @@ Message 1 - Intital Message - + @@ -890,7 +890,7 @@ Message 1 - Intital Message - + @@ -968,7 +968,7 @@ Message 1 - Intital Message - + diff --git a/Examples/REFREQ8B - Referral Service Request - CAD Out of Area C1(2 of 4 - Update).xml b/Examples/REFREQ8B - Referral Service Request - CAD Out of Area C1(2 of 4 - Update).xml index af581f7c..badc310b 100644 --- a/Examples/REFREQ8B - Referral Service Request - CAD Out of Area C1(2 of 4 - Update).xml +++ b/Examples/REFREQ8B - Referral Service Request - CAD Out of Area C1(2 of 4 - Update).xml @@ -531,14 +531,14 @@ Message 2 - First update - + - + @@ -559,7 +559,7 @@ Message 2 - First update - + @@ -589,7 +589,7 @@ Message 2 - First update - + @@ -851,14 +851,14 @@ Message 2 - First update - + - + @@ -879,14 +879,14 @@ Message 2 - First update - + - + @@ -907,14 +907,14 @@ Message 2 - First update - + - + @@ -958,7 +958,7 @@ Message 2 - First update - + @@ -969,7 +969,7 @@ Message 2 - First update - + @@ -1050,7 +1050,7 @@ Message 2 - First update - + diff --git a/Examples/REFREQ8C - Referral Service Request - CAD Out of Area C1(3 of 4 - Update).xml b/Examples/REFREQ8C - Referral Service Request - CAD Out of Area C1(3 of 4 - Update).xml index 37fcea15..297e25ab 100644 --- a/Examples/REFREQ8C - Referral Service Request - CAD Out of Area C1(3 of 4 - Update).xml +++ b/Examples/REFREQ8C - Referral Service Request - CAD Out of Area C1(3 of 4 - Update).xml @@ -525,7 +525,7 @@ Message 3 - Second update - + @@ -743,14 +743,14 @@ Message 3 - Second update - + - + @@ -771,7 +771,7 @@ Message 3 - Second update - + @@ -801,7 +801,7 @@ Message 3 - Second update - + @@ -1063,14 +1063,14 @@ Message 3 - Second update - + - + @@ -1091,14 +1091,14 @@ Message 3 - Second update - + - + @@ -1119,14 +1119,14 @@ Message 3 - Second update - + - + @@ -1170,7 +1170,7 @@ Message 3 - Second update - + @@ -1181,7 +1181,7 @@ Message 3 - Second update - + @@ -1263,7 +1263,7 @@ Message 3 - Second update - + diff --git a/Examples/REFREQ8D - Referral Service Request - CAD Out of Area C1(4 of 4 - Final Update).xml b/Examples/REFREQ8D - Referral Service Request - CAD Out of Area C1(4 of 4 - Final Update).xml index 8c82a8dd..c8898acf 100644 --- a/Examples/REFREQ8D - Referral Service Request - CAD Out of Area C1(4 of 4 - Final Update).xml +++ b/Examples/REFREQ8D - Referral Service Request - CAD Out of Area C1(4 of 4 - Final Update).xml @@ -532,7 +532,7 @@ Message 4 - Final update - + @@ -788,14 +788,14 @@ Message 4 - Final update - + - + @@ -816,7 +816,7 @@ Message 4 - Final update - + @@ -846,7 +846,7 @@ Message 4 - Final update - + @@ -1111,14 +1111,14 @@ Message 4 - Final update - + - + @@ -1139,14 +1139,14 @@ Message 4 - Final update - + - + @@ -1167,14 +1167,14 @@ Message 4 - Final update - + - + @@ -1219,7 +1219,7 @@ Message 4 - Final update - + @@ -1230,7 +1230,7 @@ Message 4 - Final update - + @@ -1313,7 +1313,7 @@ Message 4 - Final update - + diff --git a/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(1 of 3 - Initial).xml b/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(1 of 3 - Initial).xml index 9cd6b251..5dcbe283 100644 --- a/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(1 of 3 - Initial).xml +++ b/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(1 of 3 - Initial).xml @@ -470,14 +470,14 @@ Message 1 - Intital Message - + - + @@ -502,7 +502,7 @@ Message 1 - Intital Message - + @@ -761,14 +761,14 @@ Message 1 - Intital Message - + - + @@ -789,14 +789,14 @@ Message 1 - Intital Message - + - + @@ -817,14 +817,14 @@ Message 1 - Intital Message - + - + @@ -867,7 +867,7 @@ Message 1 - Intital Message - + @@ -878,7 +878,7 @@ Message 1 - Intital Message - + @@ -889,7 +889,7 @@ Message 1 - Intital Message - + diff --git a/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(2 of 3 - Update).xml b/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(2 of 3 - Update).xml index 97bd8960..22704573 100644 --- a/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(2 of 3 - Update).xml +++ b/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(2 of 3 - Update).xml @@ -492,7 +492,7 @@ Message 2 - First update - + @@ -691,14 +691,14 @@ Message 2 - First update - + - + @@ -724,7 +724,7 @@ Message 2 - First update - + @@ -986,14 +986,14 @@ Message 2 - First update - + - + @@ -1014,14 +1014,14 @@ Message 2 - First update - + - + @@ -1042,14 +1042,14 @@ Message 2 - First update - + - + @@ -1093,7 +1093,7 @@ Message 2 - First update - + @@ -1104,7 +1104,7 @@ Message 2 - First update - + @@ -1115,7 +1115,7 @@ Message 2 - First update - + diff --git a/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(3 of 3 - Final Update).xml b/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(3 of 3 - Final Update).xml index f9ba5101..028e8c10 100644 --- a/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(3 of 3 - Final Update).xml +++ b/Examples/REFREQ9A - Referral Service Request - CAD Out of Area C2(3 of 3 - Final Update).xml @@ -498,7 +498,7 @@ Message 3 - Final update - + @@ -697,14 +697,14 @@ Message 3 - Final update - + - + @@ -730,7 +730,7 @@ Message 3 - Final update - + @@ -992,14 +992,14 @@ Message 3 - Final update - + - + @@ -1020,14 +1020,14 @@ Message 3 - Final update - + - + @@ -1048,14 +1048,14 @@ Message 3 - Final update - + - + @@ -1099,7 +1099,7 @@ Message 3 - Final update - + @@ -1110,7 +1110,7 @@ Message 3 - Final update - + @@ -1121,7 +1121,7 @@ Message 3 - Final update - + diff --git a/Examples/REFRESP01 - Referral Service Request Response New Full - ED to 111 Safeguarding DNA Feedback.xml b/Examples/REFRESP01 - Referral Service Request Response New Full - ED to 111 Safeguarding DNA Feedback.xml index db1e1e4b..51d3f9fa 100644 --- a/Examples/REFRESP01 - Referral Service Request Response New Full - ED to 111 Safeguarding DNA Feedback.xml +++ b/Examples/REFRESP01 - Referral Service Request Response New Full - ED to 111 Safeguarding DNA Feedback.xml @@ -503,14 +503,14 @@ - + - + @@ -619,14 +619,14 @@ - + - + @@ -660,7 +660,7 @@ - + @@ -716,7 +716,7 @@ - + @@ -748,7 +748,7 @@ - + diff --git a/Examples/REFRESP02- Referral Service Request Reponse Short - CAD Mutual Aid Rejection.xml b/Examples/REFRESP02- Referral Service Request Reponse Short - CAD Mutual Aid Rejection.xml index db79f09c..a87ea106 100644 --- a/Examples/REFRESP02- Referral Service Request Reponse Short - CAD Mutual Aid Rejection.xml +++ b/Examples/REFRESP02- Referral Service Request Reponse Short - CAD Mutual Aid Rejection.xml @@ -390,7 +390,7 @@ - + diff --git a/Examples/REFRESP03 - Referral Service Request Response - CAD Out of Area Response.xml b/Examples/REFRESP03 - Referral Service Request Response - CAD Out of Area Response.xml index 2ac324a2..a1e42bbb 100644 --- a/Examples/REFRESP03 - Referral Service Request Response - CAD Out of Area Response.xml +++ b/Examples/REFRESP03 - Referral Service Request Response - CAD Out of Area Response.xml @@ -381,7 +381,7 @@ - + diff --git a/Examples/Task-Community Pharmacist Consultation Service for minor illness (procedure).xml b/Examples/Task-Community Pharmacist Consultation Service for minor illness (procedure).xml index 9969849a..b4b5db4a 100644 --- a/Examples/Task-Community Pharmacist Consultation Service for minor illness (procedure).xml +++ b/Examples/Task-Community Pharmacist Consultation Service for minor illness (procedure).xml @@ -4,7 +4,7 @@ - + diff --git a/Examples/VALREQ01 - Validation Service Request New Full - 999 to CAS.xml b/Examples/VALREQ01 - Validation Service Request New Full - 999 to CAS.xml index b64aeb26..de31ff82 100644 --- a/Examples/VALREQ01 - Validation Service Request New Full - 999 to CAS.xml +++ b/Examples/VALREQ01 - Validation Service Request New Full - 999 to CAS.xml @@ -394,7 +394,7 @@ - + @@ -558,14 +558,14 @@ - + - + @@ -584,7 +584,7 @@ - + diff --git a/Examples/VALREQ02 - Validation Service Request Update Full - 999 to CAS Lower Priority.xml b/Examples/VALREQ02 - Validation Service Request Update Full - 999 to CAS Lower Priority.xml index d884858e..15510db7 100644 --- a/Examples/VALREQ02 - Validation Service Request Update Full - 999 to CAS Lower Priority.xml +++ b/Examples/VALREQ02 - Validation Service Request Update Full - 999 to CAS Lower Priority.xml @@ -379,7 +379,7 @@ - + @@ -543,14 +543,14 @@ - + - + @@ -569,7 +569,7 @@ - + diff --git a/Examples/VALREQ03 - Validation Service Request New Full AMPDS - 999 to CAS.xml b/Examples/VALREQ03 - Validation Service Request New Full AMPDS - 999 to CAS.xml index ce91b50f..aed331b9 100644 --- a/Examples/VALREQ03 - Validation Service Request New Full AMPDS - 999 to CAS.xml +++ b/Examples/VALREQ03 - Validation Service Request New Full AMPDS - 999 to CAS.xml @@ -368,7 +368,7 @@ - + @@ -532,14 +532,14 @@ - + - + @@ -558,7 +558,7 @@ - + diff --git a/Examples/VALRESP01 - Validation Response HTTP Response Acknowledgment - CAS to 999 Planned (0 of 2).xml b/Examples/VALRESP01 - Validation Response HTTP Response Acknowledgment - CAS to 999 Planned (0 of 2).xml index 3e8e4f04..0dddbab8 100644 --- a/Examples/VALRESP01 - Validation Response HTTP Response Acknowledgment - CAS to 999 Planned (0 of 2).xml +++ b/Examples/VALRESP01 - Validation Response HTTP Response Acknowledgment - CAS to 999 Planned (0 of 2).xml @@ -412,7 +412,7 @@ - + @@ -576,14 +576,14 @@ - + - + @@ -602,7 +602,7 @@ - + diff --git a/Examples/VALRESP01A - Validation Response New Interim - CAS to 999 In-progress (1 of 2).xml b/Examples/VALRESP01A - Validation Response New Interim - CAS to 999 In-progress (1 of 2).xml index 600a9d88..f5c0844b 100644 --- a/Examples/VALRESP01A - Validation Response New Interim - CAS to 999 In-progress (1 of 2).xml +++ b/Examples/VALRESP01A - Validation Response New Interim - CAS to 999 In-progress (1 of 2).xml @@ -387,14 +387,14 @@ - + - + diff --git a/Examples/VALRESP01B - Validation Response Update Full - CAS to 999 Finished (2 of 2).xml b/Examples/VALRESP01B - Validation Response Update Full - CAS to 999 Finished (2 of 2).xml index 9eedd3c9..f1396a0a 100644 --- a/Examples/VALRESP01B - Validation Response Update Full - CAS to 999 Finished (2 of 2).xml +++ b/Examples/VALRESP01B - Validation Response Update Full - CAS to 999 Finished (2 of 2).xml @@ -528,14 +528,14 @@ - + - + @@ -555,7 +555,7 @@ - + diff --git a/Examples/VALRESP02 - Validation Response New Full - CAS to 999 Finished.xml b/Examples/VALRESP02 - Validation Response New Full - CAS to 999 Finished.xml index 0b795362..5090ad00 100644 --- a/Examples/VALRESP02 - Validation Response New Full - CAS to 999 Finished.xml +++ b/Examples/VALRESP02 - Validation Response New Full - CAS to 999 Finished.xml @@ -540,14 +540,14 @@ - + - + @@ -567,7 +567,7 @@ - + diff --git a/Examples/VALRESP03 - Validation Response New Full - CAS to 999 Finished Inc New CADid Cat 1-2.xml b/Examples/VALRESP03 - Validation Response New Full - CAS to 999 Finished Inc New CADid Cat 1-2.xml index d770350d..a660addc 100644 --- a/Examples/VALRESP03 - Validation Response New Full - CAS to 999 Finished Inc New CADid Cat 1-2.xml +++ b/Examples/VALRESP03 - Validation Response New Full - CAS to 999 Finished Inc New CADid Cat 1-2.xml @@ -580,14 +580,14 @@ - + - + diff --git a/Examples/VALRESP04 - Validation Response Interim - Reject Validation Request.xml b/Examples/VALRESP04 - Validation Response Interim - Reject Validation Request.xml index 04b598f2..b9aae6c0 100644 --- a/Examples/VALRESP04 - Validation Response Interim - Reject Validation Request.xml +++ b/Examples/VALRESP04 - Validation Response Interim - Reject Validation Request.xml @@ -388,14 +388,14 @@ - + - + diff --git a/Examples/VALRESP05 - Validation Response - Falls to 999 Finished copy.xml b/Examples/VALRESP05 - Validation Response - Falls to 999 Finished copy.xml index e116fa61..d22c8021 100644 --- a/Examples/VALRESP05 - Validation Response - Falls to 999 Finished copy.xml +++ b/Examples/VALRESP05 - Validation Response - Falls to 999 Finished copy.xml @@ -533,14 +533,14 @@ - + - + @@ -560,7 +560,7 @@ - + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-Integration-systems.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-Integration-systems.page.md index 430f16c3..1aa33a38 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-Integration-systems.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-Integration-systems.page.md @@ -1,6 +1,6 @@ ## {{page-title}} -We recognise that some solutions may be delivered using integration systems. To ensure the operational value of deploying a BaRS compliant solution and the spirit of the standard [HIMSS interoperability level 4](https://www.himss.org/resources/interoperability-healthcare "HIMSS interoperability level 4") is adhered to, we have developed a set of principles that integration systems should abide by. +We recognise that some solutions may be delivered using integration systems. To ensure the operational value of deploying a BaRS compliant solution and the spirit of the standard [HIMSS interoperability level 4](https://keystone.himss.org/resources/interoperability-healthcare "HIMSS interoperability level 4") is adhered to, we have developed a set of principles that integration systems should abide by. In the principles the following terms are referenced: diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Content-Negotiation/Mechanism.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Content-Negotiation/Mechanism.page.md index f9bd2be4..beb56e98 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Content-Negotiation/Mechanism.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Content-Negotiation/Mechanism.page.md @@ -75,7 +75,7 @@ The Use-Case-Category is a codeSystem that defines the use case for the message, #### Service -The Service describes if the MessageDefinition is applicable for this service. This is something that should be implied by the query parameter for GET /MessageDefinition, which acts as a filter. This capability is already described on the Get MessageDefinition page. +The Service describes if the MessageDefinition is applicable for this service. This is something that should be implied by the query parameter for GET /MessageDefinition, which acts as a filter. This capability is already described on the Get MessageDefinition page. ### Version The same SemVer rules are applied to the MessageDefinition versions. It could be the case that multiple MessageDefinitions are returned and in this scenario a Sender should select the closest version to their own from a Minor Revision and Patch perspective. If a Major version difference is detected then the Sender cannot continue unless another option is available in the response. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md index 3f24eca2..1d25ec93 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md @@ -8,7 +8,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.11.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.40.0) | 1.40.0| v1 | Live | Current Release | 19/05/2026 | Stable | {{pagelink:design-core-1.4.1, text:BaRS Core}} | 1.4.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1) | 1.4.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.4.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -42,7 +42,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.11.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.38.0) | 1.38.0| v1 | Live | Current Release | 26/03/2026 | Stable | {{pagelink:design-core-1.4.0, text:BaRS Core}} | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_4_0) | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -76,7 +76,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.37.0) | 1.37.0| v1 | Live | Current Release | 12/11/2025 | Stable | {{pagelink:design-core-1.3.1, text:BaRS Core}} | 1.3.1 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_3_0) | 1.3.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.3.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -108,7 +108,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.9.0 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.35.0) | 1.36.0| v1 | Live | Current Release | 02/07/2025 | Stable | {{pagelink:design-core-1.1.6, text:BaRS Core}} | 1.3.0 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.3.0 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.3.0 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.19 | v1 | Live | Current Release | 28/03/2025 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.8 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.8 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -139,7 +139,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.8.2 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.35.0) | 1.35.0| v1 | Live | Current Release | 01/04/2025 | Stable | {{pagelink:design-core-1.1.6, text:BaRS Core}} | 1.1.6 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.19 | v1 | Live | Current Release | 28/03/2025 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.7 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.7 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -173,7 +173,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.8.1 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.33.0) | uk.nhsdigital.bars.r4 1.33.0| v1 | Live | Current Release | 29/08/2024 | Stable | {{pagelink:design-core-1.1.5, text:BaRS Core}} | 1.1.5 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.12 | v1 | Live | Current Release | 27/11/2024 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -203,7 +203,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.8.0 | v1 | Live | Current Release | 29/08/2024 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.33.0) | uk.nhsdigital.bars.r4 1.33.0| v1 | Live | Current Release | 29/08/2024 | Stable | {{pagelink:design-core-1.1.4, text:BaRS Core}} | 1.1.4 | v1 | Live | Current Release | 29/08/2024 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.11 | v1 | Live | Current Release | 29/07/2024 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.5 | v1 | Live | Current Release | 29/08/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.5 | v1 | Live | Current Release | 29/08/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -236,7 +236,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.7.0 | v1 | Live | Current Release | 30/07/2024 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.32.0) | uk.nhsdigital.bars.r4 1.32.0| v1 | Live | Current Release | 30/07/2024 | Stable | {{pagelink:design-core-1.1.3, text:BaRS Core}} | 1.1.3 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.8 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.4 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.4 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -268,7 +268,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.6.0 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.31.0) | uk.nhsdigital.bars.r4 1.31.0 | v1 | Live | Current Release | 21/05/2024 | Stable | {{pagelink:design-core-1.1.3, text:BaRS Core}} | 1.1.3 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.8 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.4 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.4 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -300,7 +300,7 @@ Product Link | Version | Handle | Phase | State | Releas Implementation Guide | 1.5.0 | v1 | Live | Current Release | 08/03/2024 | Stable |{{pagelink:trn-General}} [FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.30.0) | uk.nhsdigital.bars.r4 1.30.0 | v1 | Live | Current Release | 11/03/2024 | Stable | {{pagelink:design-core-1.1.3, text:BaRS Core}} | 1.1.3 | v1 | Live | Current Release | 11/03/2024 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.1 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.3 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.3 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -332,7 +332,7 @@ A Clinical Safety assessment of the scope of this release has determined that it | -----------------------|---------|---------|----------|-----------------|--------------|------------|---------------- | | Implementation Guide | 1.4.0 | v1 | Live | Current Release | 17/01/2024 | Stable |{{pagelink:trn-General}} | | {{pagelink:design-core, text:BaRS Core}} | 1.1.2 | v1 | Live | Current Release | 23/11/2023 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} | -| [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} | +| [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} | | {{pagelink: build-testing, text: TKW}} | 1.0.1 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-tkw}} | | {{pagelink:application1, text:BaRS-APP1}} | 1.0.3 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} | | {{pagelink:application2, text:BaRS-APP2}} | 1.0.3 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} | @@ -365,7 +365,7 @@ Product Link | Version | Handle | Phase | State | Releas -----------------------|---------|---------|----------|-----------------|--------------|----------------|-------------- Implementation Guide | 1.3.0 | v1 | Live | Current Release | 11/09/2023 | Stable |{{pagelink:trn-General}} {{pagelink:design-core, text:BaRS Core}} | 1.1.1 | v1 | Live | Current Release | 23/11/2023 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.1 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.2 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.2 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -399,7 +399,7 @@ Product Link | Version | Handle | Phase | State | Releas -----------------------|---------|---------|----------|-----------------|--------------|----------------|--------------- Implementation Guide | 1.2.0 | v1 | Live | Current Release | 11/09/2023 | Stable |{{pagelink:trn-General}} {{pagelink:design-core, text:BaRS Core}} | 1.1.0 | v1 | Live | Current Release | 30/06/2023 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -426,7 +426,7 @@ Product Link | Version | Handle | Phase | State | Releas -----------------------|---------|---------|----------|-----------------|--------------|----------------|------------ Implementation Guide | 1.1.0 | v1 | Live | Current Release | 30/06/2023 | Stable |{{pagelink:trn-General}} {{pagelink:design-core, text:BaRS Core}} | 1.1.0 | v1 | Live | Current Release | 30/06/2023 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -454,7 +454,7 @@ Product Link | Version | Handle | Phase | State | Releas -----------------------|---------|---------|----------|-----------------|--------------|----------------|-------------- Implementation Guide | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-General}} {{pagelink:design-core, text:BaRS Core}} | 1.0.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0) | 1.0.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.0.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.1 | v1 | Live | Current Release | 11/05/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} @@ -480,7 +480,7 @@ Product Link | Version | Handle | Phase | State | Releas -----------------------|---------|---------|----------|-----------------|--------------|----------------|------------- Implementation Guide | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-General}} {{pagelink:design-core, text:BaRS Core}} | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0) | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-api}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 1.0.0 | v1 | Live | Released | 01/04/2023 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Payload.page.md index 2339280e..21099890 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Payload.page.md @@ -420,7 +420,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -436,7 +436,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -448,22 +448,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Referral-Payload.page.md index fddd2414..7f782c34 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Referral-Payload.page.md @@ -400,7 +400,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -416,7 +416,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -428,22 +428,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Referral-Payload.page.md index fdad7bb4..e2b3fde6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Referral-Payload.page.md @@ -468,7 +468,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -484,7 +484,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -496,22 +496,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md index 0e1c0b6f..f7cb8e8e 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md @@ -61,7 +61,7 @@ For Validation Response example bundles see: * [Validation Response - CAS to 999 Finished](https://simplifier.net/nhsbookingandreferrals/76a303c5-3260-4a80-96b9-5c7995514bc1) * [Validation Response - CAS to 999 Finished Inc third encounter case ID for C1/C2 outcome](https://simplifier.net/nhsbookingandreferrals/256a050f-9896-4b32-95ff-62f044722c83) -* [Validation Response - Falls to 999 Finished](https://simplifier.net/nhsbookingandreferrals/76a303c5-3260-4a80-96b9-5c7995514bd2) +* [Validation Response - Falls to 999 Finished](https://simplifier.net/nhsbookingandreferrals/76a303c5-3260-4a80-96b9-5c7995514bc1-duplicate-2) * For additional example bundles please check [BaRS Example Bundles](https://simplifier.net/nhsbookingandreferrals/~resources?category=Example&exampletype=Bundle&sortBy=LastUpdateDate_desc) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Request-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Request-Payload.page.md index baab1e18..8bb8e04a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Request-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Request-Payload.page.md @@ -470,7 +470,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -486,7 +486,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -498,22 +498,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Response-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Response-Payload.page.md index 64721d75..22b102a0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Response-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Validation-Response-Payload.page.md @@ -488,7 +488,7 @@ This payload is used to transmit the outcome of the validation assessment back t | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -504,7 +504,7 @@ This payload is used to transmit the outcome of the validation assessment back t | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -516,22 +516,22 @@ This payload is used to transmit the outcome of the validation assessment back t | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md index d257f351..8bb60130 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md @@ -305,7 +305,7 @@ This payload is used to transmit all the necessary information that is required | Condition.clinicalStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | active | | Condition.verificationStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | unconfirmed | | Condition.category | The qualifier of the problem or issue necessitating the referral request | MUST | 0..1 | | -| Condition.category.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct | +| Condition.category.coding.system | This MUST be populated with CodeSystem - https://termbrowser.nhs.uk | MUST | 0..1 | https://termbrowser.nhs.uk | | Condition.category.coding.code | This MUST be populated with the Code (SNOMED) of the class of problem or issue | MUST | 0..1 | 33962009 | | Condition.category.coding.display | This MUST be populated with the human readable Display (SNOMED) of the class of problem or issue | MUST | 0..1 | Presenting complaint | | Condition.code | The 'presenting complaint or issue' (as defined in the Information model) that precipitated the generation of the associated CarePlan | MUST | 0..1 | | @@ -337,7 +337,7 @@ This payload is used to transmit all the necessary information that is required | Task.status | This MUST be populated with 'requested' - Fixed Value | MUST | 1..1 | requested | | Task.intent | This MUST be populated with 'order' - Fixed Value | MUST | 1..1 | order | | Task.code | This MUST be populated with the action (by the specific Pharmacy Service (Referral Type)) the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | | -| Task.code.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct | +| Task.code.coding.system | This MUST be populated with CodeSystem - https://termbrowser.nhs.uk | MUST | 0..1 | https://termbrowser.nhs.uk | | Task.code.coding.code | This MUST be populated with the Code (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | 2140231000000104 | | Task.code.coding.display | This MUST be populated with the human readable Display (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | Referral to Community Pharmacy Pharmacy First Service (procedure) | | Task.description | This SHOULD be populated with a human readable summary of the intended instruction of the Task, combining the key elements e.g. Task.code and Task.restriction.period | SHOULD | 0..1 | 'Patient will contact pharmacy service. If, upon receipt, the pharmacist has concerns over the patient's condition they should contact the patient.' | @@ -373,7 +373,7 @@ This payload is used to transmit all the necessary information that is required | Organization.identifier.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.nhs.uk/id/ods-organization-code | | Organization.identifier.value | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | ABD01 | | Organization.type | This is important to add type for the Sending organisation and has an explicit requirement to include. If it is available for the Receiving organisation is should be included. | SHOULD | 0..* | | -| Organization.type.coding.system | This MUST be populated to indicate the system value, using SNOMED ReferenceSet 1127531000000102 | MUST | 0..1 | http://snomed.info/sct | +| Organization.type.coding.system | This MUST be populated to indicate the system value, using SNOMED ReferenceSet 1127531000000102 | MUST | 0..1 | https://termbrowser.nhs.uk | | Organization.type.coding.value | This MUST be populated with the Value of the selected code of the organisation type. | MUST | 0..1 | 788007007 | | Organization.type.coding.display | This MUST be populated with the Display of the selected code of the organisation type. | MUST | 0..1 | General practice service (qualifier value) | | Organization.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name | @@ -492,7 +492,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -508,7 +508,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -520,22 +520,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | @@ -618,7 +618,7 @@ This payload is used to transmit all the necessary information that is required | Observation.category.coding.code | This SHOULD be populated with the Code of the Observation. See CodeSystem http://terminology.hl7.org/CodeSystem/observation-category | SHOULD | 0..1 | vital-signs | | Observation.code | This MUST be populated indicating the type of Observation, preferrably coded. | MUST | 1..1 | | | Observation.code.coding | This SHOULD be populated with the coded value of the type of Observation | SHOULD | 0..1 | | -| Observation.code.coding.system | This SHOULD be populated with the code system of the type of Observation | SHOULD | 0..1 | http://snomed.info/sct | +| Observation.code.coding.system | This SHOULD be populated with the code system of the type of Observation | SHOULD | 0..1 | https://termbrowser.nhs.uk | | Observation.code.coding.code | This SHOULD be populated with the code of the type of Observation | SHOULD | 0..1 | 75367002 | | Observation.code.coding.display | This SHOULD be populated with the code display of the type of Observation | SHOULD | 0..1 | Blood pressure (observable entity) | | Observation.performer | | SHOULD | 0..* | | @@ -637,7 +637,7 @@ This payload is used to transmit all the necessary information that is required | Observation.component | The element details the results of an observation and is explicitly used for Blood Pressure in the current use-cases. | MAY | | | | Observation.component.code | This MAY be populated to indicate the type of result in coded form | MAY | 1..1 | | | Observation.component.code.coding | This MAY be populated to indicate the code of the type of result | MAY | 0..1 | | -| Observation.component.code.coding.system | This MAY be populated to indicate the code system of the result | MAY | 0..1 | http://snomed.info/sct | +| Observation.component.code.coding.system | This MAY be populated to indicate the code system of the result | MAY | 0..1 | https://termbrowser.nhs.uk | | Observation.component.code.coding.code | This MAY be populated to indicate the code of the result | MAY | 0..1 | 271649006 | | Observation.component.code.coding.display | This MAY be populated to indicate the code display of the result | MAY | 0..1 | Systolic blood pressure | | Observation.component.text | This MAY be populated to indicate the text of the result | MAY | 0..1 | Systolic blood pressure | 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 197bb24f..08a5a41b 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 @@ -315,11 +315,11 @@ This payload is used to transmit all the necessary information that is required | Condition.clinicalStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | | | Condition.clinicalStatus.coding.code | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | active | | Condition.category | The qualifier of the problem or issue necessitating the referral request | MUST | 0..1 | | -| Condition.category.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | SHOULD | 0..1 | http://snomed.info/sct | +| Condition.category.coding.system | This MUST be populated with CodeSystem - https://termbrowser.nhs.uk | SHOULD | 0..1 | https://termbrowser.nhs.uk | | Condition.category.coding.code | This MUST be populated with the Code (SNOMED) of the class of problem or issue | MUST | 0..1 | 33962009 | | Condition.category.coding.display | This MUST be populated with the human readable Display (SNOMED) of the class of problem or issue | MUST | 0..1 | Presenting complaint | | Condition.code | The 'presenting complaint or issue' (as defined in the Information model) that precipitated the generation of the associated CarePlan | MUST | 0..1 | | -| Condition.code.coding.system | This COULD be populated with http://snomed.info/sct | COULD | 0..1 | http://snomed.info/sct | +| Condition.code.coding.system | This COULD be populated with https://termbrowser.nhs.uk | COULD | 0..1 | https://termbrowser.nhs.uk | | Condition.code.coding.code | This COULD be populated with the Code (SNOMED) of the class of problem or issue | COULD | 0..1 | 16932000 | | Condition.code.coding.display | This COULD be populated with the human readable Display (SNOMED) of the problem or issue | COULD | 0..1 | Nausea and vomiting (disorder) | | Condition.code.text | When passing the Reason for Call this SHOULD be populated with the free text description of the Reason for call | SHOULD | 0..1 | Nausea and vomiting | @@ -349,7 +349,7 @@ This payload is used to transmit all the necessary information that is required | Task.status | This MUST be populated with 'requested' - Fixed Value | MUST | 1..1 | requested | | Task.intent | This MUST be populated with 'plan' - Fixed Value | MUST | 1..1 | plan | | Task.code | This MUST be populated with the action (by the specific Ambulance Service (Referral Type)) the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | | -| Task.code.coding.system | This COULD be populated with CodeSystem - http://snomed.info/sct | COULD | 0..1 | http://snomed.info/sct | +| Task.code.coding.system | This COULD be populated with CodeSystem - https://termbrowser.nhs.uk | COULD | 0..1 | https://termbrowser.nhs.uk | | Task.code.coding.code | This COULD be populated with the Code (SNOMED) of the task | COULD | 0..1 | 715537001 | | Task.code.coding.display | This COULD be populated with the human readable Display (SNOMED) of the task | COULD | 0..1 | Transportation by ambulance | | Task.description | This SHOULD be populated with a plain text representation of the task | SHOULD | 0..1 | Patient requires transport by ambulance | @@ -537,7 +537,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -553,7 +553,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -565,22 +565,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | @@ -849,7 +849,7 @@ This payload is used to transmit all the necessary information that is required | Questionnaire.item.required | This MUST be populated to ensure the answer to the question is included in results | MUST | 0..1 | true | | Questionnaire.item.answerOption | This MUST be populated and as a containing array for the available options for selection for the question being defined. | MUST | 0..1 | | | Questionnaire.item.answerOption.valueCoding | This MUST be populated to contain the coded values for the array. In BaRS defined Questionnaire, only valueCoding is support for this Application | MUST | 0..1 | | -| Questionnaire.item.answerOption.valueCoding.system | This SHOULD be populated with CodeSystem - http://snomed.info/sct | SHOULD | 0..1 | http://snomed.info/sct | +| Questionnaire.item.answerOption.valueCoding.system | This SHOULD be populated with CodeSystem - https://termbrowser.nhs.uk | SHOULD | 0..1 | https://termbrowser.nhs.uk | | Questionnaire.item.answerOption.valueCoding.code | This MUST be populated with the Code of the optional value | MUST | 0..1 | 428913001 | | Questionnaire.item.answerOption.valueCoding.display | This SHOULD be populated with the human readable Display of the optional value | SHOULD | 0..1 | No loss of consciousness (situation) | @@ -890,7 +890,7 @@ This payload is used to transmit all the necessary information that is required | QuestionnaireResponse.item.text | This MUST be populated with question text of the corresponding Questionnaire question | MUST | 0..1 | Is the patient breathing? | | QuestionnaireResponse.item.answer | This MUST be populated with the answer to the corresponding Questionnaire question | MUST | 0..* | | | QuestionnaireResponse.item.answer.valueCoding | This MUST be populated with the answer value from the answerOptions defined within the Questionnaire | MUST | 0..1 | | -| QuestionnaireResponse.item.answer.valueCoding.system | This SHOULD be populated (and MUST be where it is defined in the Questionnaire answerOption) with the System namespace for the CodeSystem based on the defined answerOptions in the corresponding Questionnaire question | SHOULD | 0..1 | http://snomed.info/sct | +| QuestionnaireResponse.item.answer.valueCoding.system | This SHOULD be populated (and MUST be where it is defined in the Questionnaire answerOption) with the System namespace for the CodeSystem based on the defined answerOptions in the corresponding Questionnaire question | SHOULD | 0..1 | https://termbrowser.nhs.uk | | QuestionnaireResponse.item.answer.valueCoding.code | This MUST be populated with Code of the defined answerOptions in the corresponding Questionnaire question | MUST | 0..1 | 78064003 | | QuestionnaireResponse.item.answer.valueCoding.display | This SHOULD be populated (and MUST be where it is defined in the Questionnaire answerOption) with Display of the defined answerOptions in the corresponding Questionnaire question | SHOULD | 0..1 | Breathing (observable entity) | @@ -912,7 +912,7 @@ This payload is used to transmit all the necessary information that is required | Procedure.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | | Procedure.status | This MUST have a status of 'in-progress' - FIXED VALUE | MUST | 1..1 | in-progress | | Procedure.code | Identification of the procedure | MUST | 0..1 | | -| Procedure.code.coding.system | This SHOULD be populated with CodeSystem - http://snomed.info/sct | SHOULD | 0..1 | http://snomed.info/sct | +| Procedure.code.coding.system | This SHOULD be populated with CodeSystem - https://termbrowser.nhs.uk | SHOULD | 0..1 | https://termbrowser.nhs.uk | | Procedure.code.coding.code | This SHOULD be populated with the Code (SNOMED) of the procedure | SHOULD | 0..1 | 89666000 | | Procedure.code.coding.display | This SHOULD be populated with the human readable Display (SNOMED) of the procedure | SHOULD | 0..1 | Cardiopulmonary resuscitation (procedure) | | Procedure.code.text | Plain text representation of the procedure | COULD | 0..1 | CPR | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/How-does-it-work.page.md index f92f3c5c..05c1967b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/How-does-it-work.page.md @@ -22,7 +22,7 @@ During a referral workflow where booking is required, there are two separate pro The first part of this process involves the **sender** making a request to the **receiver** for slots that match the search criteria. This is a "searching" request that requires the response body to include a "searchset" bundle resource. -The search parameters are defined on the BaRS API specification documentation. +The search parameters are defined on the BaRS API specification documentation. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Index.page.md index 938707df..b09c9913 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Index.page.md @@ -24,7 +24,7 @@ topic: Application7 Application 7 v1.0.0-alpha.4 v1.0.x v1.9.0 - v1.3.0 + v1.3.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md index 4be5caed..f56626fd 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md @@ -121,7 +121,7 @@ This payload is used to transmit all the necessary information that is required | ServiceRequest.category.coding.display | This MUST be populated with Display for the use-case. See CodeSystem: https://fhir.nhs.uk/CodeSystem/usecases-categories-bars | MUST | 0..1 | Assessment to e-RS broker | | ServiceRequest.code | This MUST be populated, if including orderDetail | COULD | 0..1 | | | ServiceRequest.code.coding | This MUST be populated with a SNOMED Coded Value. This should be kept generic with the main request and next step being reserved for Task.Code | MUST | 0..1 | | -| ServiceRequest.code.coding.system | This MUST be populated with the SNOMED Code System | MUST | 0..1 | http://snomed.info/sct | +| ServiceRequest.code.coding.system | This MUST be populated with the SNOMED Code System | MUST | 0..1 | https://termbrowser.nhs.uk | | ServiceRequest.code.coding.value | This MUST be populated with the SNOMED Code Value | MUST | 0..1 | 792891000000102 | | ServiceRequest.code.coding.display | This MUST be populated with the SNOMED Code Display | MUST | 0..1 | Inbound referral | | ServiceRequest.orderDetail | "This COULD be populated where one of the shortlisted services being offered to the broker requires a referral letter (indicated by Referral Letter Required flag) Two optionsin the CodeSystem are NEED_TO_ADD_LATER
NOT_INTENDING_TO_ADD" | COULD | 0..1 | | @@ -312,7 +312,7 @@ This payload is used to transmit all the necessary information that is required | Condition.clinicalStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | active | | Condition.verificationStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | unconfirmed | | Condition.category | The qualifier of the problem or issue necessitating the referral request | MUST | 0..1 | | -| Condition.category.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct | +| Condition.category.coding.system | This MUST be populated with CodeSystem - https://termbrowser.nhs.uk | MUST | 0..1 | https://termbrowser.nhs.uk | | Condition.category.coding.code | This MUST be populated with the Code (SNOMED) of the class of problem or issue | MUST | 0..1 | 33962009 | | Condition.category.coding.display | This MUST be populated with the human readable Display (SNOMED) of the class of problem or issue | MUST | 0..1 | Presenting complaint | | Condition.code | The 'presenting complaint or issue' (as defined in the Information model) that precipitated the generation of the associated CarePlan | MUST | 0..1 | | @@ -341,7 +341,7 @@ This payload is used to transmit all the necessary information that is required | Task.status | This MUST be populated with 'requested' - Fixed Value | MUST | 1..1 | requested | | Task.intent | This MUST be populated with 'order' - Fixed Value | MUST | 1..1 | order | | Task.code | This MUST be populated with the action the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | | -| Task.code.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct | +| Task.code.coding.system | This MUST be populated with CodeSystem - https://termbrowser.nhs.uk | MUST | 0..1 | https://termbrowser.nhs.uk | | Task.code.coding.code | This MUST be populated with the Code (SNOMED) of action | MUST | 0..1 | 792891000000102 | | Task.code.coding.display | This MUST be populated with the human readable Display (SNOMED) of action | MUST | 0..1 | Inbound referral | | Task.description | This SHOULD be populated with a human readable summary of the intended instruction of the Task, combining the key elements e.g. Task.code and Task.restriction.period | SHOULD | 0..1 | Provide healthcare service options to patient/client for selection' | @@ -368,7 +368,7 @@ This payload is used to transmit all the necessary information that is required | Organization.identifier.system | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | https://fhir.nhs.uk/id/ods-organization-code | | Organization.identifier.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | ABD01 | | Organization.type | This is important to add type for the Sending organisation and has an explicit requirement to include. If it is available for the Receiving organisation is should be included. | SHOULD | 0..* | | -| Organization.type.coding.system | This MUST be populated to indicate the system value, using SNOMED ReferenceSet 1127531000000102 | MUST | 0..1 | http://snomed.info/sct | +| Organization.type.coding.system | This MUST be populated to indicate the system value, using SNOMED ReferenceSet 1127531000000102 | MUST | 0..1 | https://termbrowser.nhs.uk | | Organization.type.coding.value | This MUST be populated with the Value of the selected code of the organisation type. | MUST | 0..1 | 788007007 | | Organization.type.coding.display | This MUST be populated with the Display of the selected code of the organisation type. | MUST | 0..1 | General practice service (qualifier value) | | Organization.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name | @@ -494,7 +494,7 @@ This payload is used to transmit all the necessary information that is required | Flag.category.coding.display | This MUST be populated with the Display of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | Additional Patient Information | | Flag.code | | MUST | 1..1 | | | Flag.code.coding | This MUST be populated with the detail of what is being flagged in Flag Category. e.g. for Reasonable Adjustment (Flag Category): 'adjustforneedlephobia'(Code) 'Adjust for needle phobia'(Display). It would not be appropriate to indicate a Category of 'Safeguarding' and a Code of 'Reasonable Adjustment'. The Category and Code MUST correlate. | MUST | 1..1 | | -| Flag.code.coding.system | This MUST be populated with the Coding System for what is being flagged e.g. https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars | MUST | 0..1 | http://snomed.info/sct | +| Flag.code.coding.system | This MUST be populated with the Coding System for what is being flagged e.g. https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars | MUST | 0..1 | https://termbrowser.nhs.uk | | Flag.code.coding.code | This MUST be populated with the relevant Code from the selected Flag code CodeSystem | MUST | 0..1 | 772132005 | | Flag.code.coding.display | This MUST be populated with the Display text from the Flag code CodeSystem | MUST | 0..1 | Moderate risk of harm to others | | Flag.subject | | MUST | 1..1 | | @@ -520,7 +520,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.status | Follow UK Core guidance for populating this element | MUST | 1..1 | active | | MedicationStatement.category | | MAY | 0..1 | | | MedicationStatement.category.coding | | MUST | 1..1 | | -| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medication-statement-category | +| MedicationStatement.category.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://terminology.hl7.org/CodeSystem/medicationrequest-category | | MedicationStatement.category.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | outpatient | | MedicationStatement.category.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Outpatient | | MedicationStatement.medicationCodeableConcept | | MUST | 1..1 | | @@ -536,7 +536,7 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dateAsserted | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2021-10-22 | | MedicationStatement.reasonCode | | SHOULD | 0..* | | | MedicationStatement.reasonCode.coding | | MUST | 1..1 | | -| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.reasonCode.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.reasonCode.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 65363002 | | MedicationStatement.reasonCode.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otitis Media | | MedicationStatement.dosage | | SHOULD | 0..* | | @@ -548,22 +548,22 @@ This payload is used to transmit all the necessary information that is required | MedicationStatement.dosage.timing.repeat.period unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | d | | MedicationStatement.dosage.asNeededCodeableConcept | | SHOULD | 0..1 | | | MedicationStatement.dosage.asNeededCodeableConcept.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.asNeededCodeableConcept.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.asNeededCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 16001004 | | MedicationStatement.dosage.asNeededCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Otalgia | | MedicationStatement.dosage.site | | MAY | 0..1 | | | MedicationStatement.dosage.site.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.site.coding.system | Follow UK Core guidance for populating this element | MAY | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.site.coding.code | Follow UK Core guidance for populating this element | MAY | 0..1 | 123851003 | | MedicationStatement.dosage.site.coding.display | Follow UK Core guidance for populating this element | MAY | 0..1 | Mouth region structure | | MedicationStatement.dosage.route | | SHOULD | 0..1 | | | MedicationStatement.dosage.route.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.route.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.route.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 26643006 | | MedicationStatement.dosage.route.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Oral | | MedicationStatement.dosage.method | | SHOULD | 0..* | | | MedicationStatement.dosage.method.coding | | MUST | 1..1 | | -| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://snomed.info/sct | +| MedicationStatement.dosage.method.coding.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://termbrowser.nhs.uk | | MedicationStatement.dosage.method.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 421984009 | | MedicationStatement.dosage.method.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Until finished | | MedicationStatement.dosage.doseAndRate | | SHOULD | 0..* | | 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 1a533514..478d93be 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 @@ -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)}} |

111 Online - ED
111 Online - UTC
S&R - ED
S&R - UTC

| 2.1.0 | v1.0.0 | v1.0.0 | | {{pagelink:application3, text: Referral into UEC (Application 3)}} |

999-CAS Referral
| 2.0.0 | v1.0.0 | v1.0.0 | | {{pagelink:application4, text: Referral into UEC for Validation (Application 4)}} |

999-CAS Validation

999 AST to Falls Lifting Service

999 AST to Community Services
| 2.0.0 | v1.0.0 | v1.0.0 | -| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} |

Primary Care to Community Pharmacy (Pharmacy First)

Primary Care to Pharmacy Contraception (Oral Contraception)

Primary Care to Pharmacy Blood Pressure Check Service
| 1.2.0 | v1.3.0 | {{pagelink:design-core-1.6.0, text:v1.3.0}} | +| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} |

Primary Care to Community Pharmacy (Pharmacy First)

Primary Care to Pharmacy Contraception (Oral Contraception)

Primary Care to Pharmacy Blood Pressure Check Service
| 1.2.0 | v1.4.1 | {{pagelink:design-core-1.4.1, text:v1.4.1}} |

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 0623bcf9..a3d5af51 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 @@ -14,9 +14,9 @@ These guides are designed to be used in conjunction with the documentation for { | Application | Use Cases | Current Release | API Specification | Core Version | | ----------------------------------------------------------------------------|--------------------------------------------------------------- | --------------- | --------------- | --------------- | -| {{pagelink:application6, text: Referrals into an Ambulance Service Trust (Application 6)}} |

CAD to CAD Out of Area Referral
CAD to CAD Call Assist Request
CAD to CAD Mutual Aid Request | 1.0.0-beta.8 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | -| {{pagelink:application7, text: Bookings into GP Practice (Application 7)}} |

Appointments for Patient facing services into GP Practice | 1.0.0-alpha.4 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | -| {{pagelink:application8, text: Referrals into a broker for Healthcare Service selection (Application 8)}} |

Advice and guidance referring into electronic Referral Service (eRS)
111 Online referring into electronic Referral Service
nhs.uk referring into electronic Referral Service | 1.0.0-alpha.3 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | +| {{pagelink:application6, text: Referrals into an Ambulance Service Trust (Application 6)}} |

CAD to CAD Out of Area Referral
CAD to CAD Call Assist Request
CAD to CAD Mutual Aid Request | 1.0.0-beta.8 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | +| {{pagelink:application7, text: Bookings into GP Practice (Application 7)}} |

Appointments for Patient facing services into GP Practice | 1.0.0-alpha.4 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | +| {{pagelink:application8, text: Referrals into a broker for Healthcare Service selection (Application 8)}} |

Advice and guidance referring into electronic Referral Service (eRS)
111 Online referring into electronic Referral Service
nhs.uk referring into electronic Referral Service | 1.0.0-alpha.3 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | ## Beta Deployment Guide diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Environments.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Environments.page.md index 936e967f..b59115f0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Environments.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Environments.page.md @@ -1,7 +1,7 @@ ## {{page-title}} -BaRS API usage examples are available from the [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). It demonstrates key functionality without the overhead of security requirements, giving developers the opportunity to understand the product before progressing development. +BaRS API usage examples are available from the [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/). It demonstrates key functionality without the overhead of security requirements, giving developers the opportunity to understand the product before progressing development. BaRS Integration (INT) is a live-like environment for suppliers progressing with development and testing to use. To use INT, you will need to follow the instructions to {{pagelink:connect-as-a-sender, text:Connect as a sender}} or {{pagelink:connect-as-a-receiver, text:Connect as a receiver}} diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Update-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Update-Existing-Booking.page.md index d6204396..a7607479 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Update-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Update-Existing-Booking.page.md @@ -26,7 +26,7 @@ resource returned: { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165342003", "display": "Patient declined laboratory test (situation)" } @@ -63,7 +63,7 @@ Request Body { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165332000", "display": "Laboratory test requested (situation)" } diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 91b3df3a..a583f521 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Update-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Update-Existing-Booking.page.md index 01142588..3323f0fd 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Update-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Update-Existing-Booking.page.md @@ -26,7 +26,7 @@ resource returned: { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165342003", "display": "Patient declined laboratory test (situation)" } @@ -63,7 +63,7 @@ Request Body { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165332000", "display": "Laboratory test requested (situation)" } diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index dadf8997..a054b27d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the existing Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequest | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequest | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/Appointment-StandardPattern/Update-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/Appointment-StandardPattern/Update-Existing-Booking.page.md index b7be212a..f670fa77 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/Appointment-StandardPattern/Update-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/Appointment-StandardPattern/Update-Existing-Booking.page.md @@ -26,7 +26,7 @@ resource returned: { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165342003", "display": "Patient declined laboratory test (situation)" } @@ -63,7 +63,7 @@ Request Body { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165332000", "display": "Laboratory test requested (situation)" } diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index af2497fc..65f4eb90 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-5-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the existing Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequest | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequest | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/Appointment-StandardPattern/Update-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/Appointment-StandardPattern/Update-Existing-Booking.page.md index 80dd4002..93543de4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/Appointment-StandardPattern/Update-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/Appointment-StandardPattern/Update-Existing-Booking.page.md @@ -26,7 +26,7 @@ resource returned: { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165342003", "display": "Patient declined laboratory test (situation)" } @@ -63,7 +63,7 @@ Request Body { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165332000", "display": "Laboratory test requested (situation)" } diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 0fd9a7a9..da0d753c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-6-0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the existing Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequest | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequest | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 542ec21f..6ba60fa4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index a4f5663c..7235430b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index be9a78c6..696eb456 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index df03dd3d..a79421af 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 6bbcc05d..d550023f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 5077792a..5c20fdc6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index e5fbb6f9..f7a997f3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Cancel-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Cancel-Booking.page.md index 302334ce..29b63ce4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Cancel-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Cancel-Booking.page.md @@ -6,9 +6,9 @@ topic: core-StandardPattern-appointment-cancel-1.3.0 To cancel an appointment: -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, the read can be undertaken with [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment), using the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} workflow, and selecting the .id by the matching the required resource. NB: If a match cannot be performed, using this method, manual processes should be engaged. +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, the read can be undertaken with [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment), using the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} workflow, and selecting the .id by the matching the required resource. NB: If a match cannot be performed, using this method, manual processes should be engaged. * Set the Appointment.status value to "cancelled" -* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} resource returned: ```json diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Initial-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Initial-Booking.page.md index e598dc14..9233b16d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Initial-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Initial-Booking.page.md @@ -9,13 +9,13 @@ Below are examples of each of the described interactions. The appointment resour Any operations that modify an existing resource must perform a read before a write. GET /Appointment/\{id\} ### Book -The method for the initial booking of an appointment depends on the {{pagelink:Home/Applications/BaRS-Applications, text:Application}} specific guidance within BaRS. Within BaRS Applications, making a booking will involve building a FHIR bundle and making a POST to the [$process-message](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/$process-message) endpoint. Alternatively, booking an appointment can be used outside of use-cases supported by a BaRS Application, to fulfil a generic Appointment Management Foundation workflow against the discete [booking endpoints](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment), either way, the typical sequence of events is: +The method for the initial booking of an appointment depends on the {{pagelink:Home/Applications/BaRS-Applications, text:Application}} specific guidance within BaRS. Within BaRS Applications, making a booking will involve building a FHIR bundle and making a POST to the [$process-message](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/$process-message) endpoint. Alternatively, booking an appointment can be used outside of use-cases supported by a BaRS Application, to fulfil a generic Appointment Management Foundation workflow against the discete [booking endpoints](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment), either way, the typical sequence of events is: * {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.3.0, text:Select the service}} to book an appointment with. -* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/metadata). -* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot). +* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/metadata). +* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot). * Select a slot. -* Send a Request to [book an appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) in that slot +* Send a Request to [book an appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) in that slot Request Body diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md index b4f33576..d35e1c36 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md @@ -10,7 +10,7 @@ topic: core-StandardPattern-appointment-Introduction-1.3.0 ## Introduction -The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). +The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/). This includes using {{pagelink:core-StandardPattern-document-reference-1.3.0, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central repository, commonly referred to as the Registry. @@ -29,18 +29,18 @@ There are four functions that are required surrounding appointments. This sectio ## Interface -The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| -| [List](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference) | /DocumentReference | GET | Using the {{pagelink:core-StandardPattern-document-reference-Introduction-1.3.0, text:DocumentReference}} pattern, a list of existing appointments for a patient can be viewed with the central Registry. | -| [View](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) | /Appointment/\{id\} | GET | This action, using the id from the List capability, will allow that specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) from the healthcare service who owns it. | -| [View (Search)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment) | /Appointment | GET | If the Appointment.id is not known, the Sender can perform a look up based the patient national identifier (NHS No.) or demographics (Name (as defined by [FHIR](https://simplifier.net/packages/hl7.fhir.r4.core/4.0.1/files/2834389 )), Date of Birth, Home Address Postcode). This returns a (FHIR) bundle of resources for the specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment) from the healthcare service who owns it. See {{pagelink:core-SPCancellation-1.3.0, text:Cancellation}} for further detail.| -| [Get Slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot) | /Slots | GET | Obtain a list of available booking slots from a specified receiving system using the [GET /Slots endpoint](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot) | -| [Book](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) | /Appointment or /$process-message | POST | This will be a POST operation, with a BaRS Application /$process-message is typically used, outside of supported use cases /Appointment is adopted.| -| [Cancel](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) | /Appointment/\{id\} | PUT| The cancel of a booking will be setting the status of the appointment to "cancelled". Cancel is also possible using /$process-message | -| [Update](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) | /Appointment/\{id\} | PUT / PATCH| An update to an appointment will be a direct update to the existing resource | -| [Rebook](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) | Composite of Cancel and then Book | Composite | Requesting a new booking and then cancelling the existing one will constitute a rebook | +| [List](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/DocumentReference) | /DocumentReference | GET | Using the {{pagelink:core-StandardPattern-document-reference-Introduction-1.3.0, text:DocumentReference}} pattern, a list of existing appointments for a patient can be viewed with the central Registry. | +| [View](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) | /Appointment/\{id\} | GET | This action, using the id from the List capability, will allow that specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) from the healthcare service who owns it. | +| [View (Search)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment) | /Appointment | GET | If the Appointment.id is not known, the Sender can perform a look up based the patient national identifier (NHS No.) or demographics (Name (as defined by [FHIR](https://simplifier.net/packages/hl7.fhir.r4.core/4.0.1/files/2834389 )), Date of Birth, Home Address Postcode). This returns a (FHIR) bundle of resources for the specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment) from the healthcare service who owns it. See {{pagelink:core-SPCancellation-1.3.0, text:Cancellation}} for further detail.| +| [Get Slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot) | /Slots | GET | Obtain a list of available booking slots from a specified receiving system using the [GET /Slots endpoint](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot) | +| [Book](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) | /Appointment or /$process-message | POST | This will be a POST operation, with a BaRS Application /$process-message is typically used, outside of supported use cases /Appointment is adopted.| +| [Cancel](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) | /Appointment/\{id\} | PUT| The cancel of a booking will be setting the status of the appointment to "cancelled". Cancel is also possible using /$process-message | +| [Update](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) | /Appointment/\{id\} | PUT / PATCH| An update to an appointment will be a direct update to the existing resource | +| [Rebook](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) | Composite of Cancel and then Book | Composite | Requesting a new booking and then cancelling the existing one will constitute a rebook | -In line with the BaRS standard all operations used to modify a resource must be preceded by a read of the resource by means of a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation. +In line with the BaRS standard all operations used to modify a resource must be preceded by a read of the resource by means of a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Rebook-Methods.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Rebook-Methods.page.md index 7d4efb33..53837f41 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Rebook-Methods.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Rebook-Methods.page.md @@ -31,12 +31,12 @@ The method for the subsequent booking of an appointment depends on the Applicati Alternatively, rebooking an appointment can be used outside of use-cases supported by a BaRS Application, to fulfil a generic Appointment workflow, either way, the typical sequence of events using PUT or POST is: * {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.3.0, text:Select the service}} to book an appointment with. -* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/metadata). -* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot). +* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/metadata). +* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot). * Select a slot. -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, the read can be undertaken with [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment), using the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} workflow, and selecting the .id by the matching the required resource. NB: If a match cannot be performed, using this method, manual processes should be engaged. +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, the read can be undertaken with [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment), using the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} workflow, and selecting the .id by the matching the required resource. NB: If a match cannot be performed, using this method, manual processes should be engaged. * Set the Appointment.status value to "cancelled" -* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} Request Body @@ -79,12 +79,12 @@ Request Body Using PATCH: * {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.3.0, text:Select the service}} to book an appointment with. -* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/metadata). -* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot). +* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/metadata). +* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot). * Select a slot. -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} * Set the Appointment.status value to "cancelled" -* Perform a [PATCH](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#patch-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Perform a [PATCH](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#patch-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} ```json { diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Update-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Update-Existing-Booking.page.md index 699303a4..89211396 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Update-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Update-Existing-Booking.page.md @@ -6,9 +6,9 @@ topic: core-StandardPattern-appointment-update-1.3.0 To update an appointment: -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, the read can be undertaken with [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment), using the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} workflow, and selecting the .id by the matching the required resource. NB: If a match cannot be performed, using this method, manual processes should be engaged. +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, the read can be undertaken with [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment), using the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} workflow, and selecting the .id by the matching the required resource. NB: If a match cannot be performed, using this method, manual processes should be engaged. * Amend or append the resource as required. -* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} In this example a placeholder was created, and updated when the slot is selected. This is a hypothetical scenario. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 87f8d24c..b5562ca6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/BaRS-FHIR-API.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/BaRS-FHIR-API.page.md index 755866eb..da6433ec 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/BaRS-FHIR-API.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/BaRS-FHIR-API.page.md @@ -4,11 +4,11 @@ topic: core-EndToEndWorkflow-API-1.3.0 ## BaRS FHIR API -The [BaRS FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) supports all functionality with receiver APIs for both booking and referrals. Once an access token has been obtained, the sender can start making requests of the API. +The [BaRS FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) supports all functionality with receiver APIs for both booking and referrals. Once an access token has been obtained, the sender can start making requests of the API. Note: With every API request the sender must include the HTTP header parameter 'NHSD-Target Identifier'. -You can find details for each endpoint in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). +You can find details for each endpoint in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/).


\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/HTTP-Header.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/HTTP-Header.page.md index 86cc60fa..d9a8cddd 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/HTTP-Header.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/End-to-end-workflow/HTTP-Header.page.md @@ -5,7 +5,7 @@ topic: core-EndToEndWorkflow-HTTPHeader-1.3.0 ## {{page-title}} -The BaRS API specifies several additional headers, many of which are items described in a standard Base64 encoded object (JSON). Their purpose and usage are described below. Examples can be found in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). +The BaRS API specifies several additional headers, many of which are items described in a standard Base64 encoded object (JSON). Their purpose and usage are described below. Examples can be found in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/).

\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Interface.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Interface.md index 050725f1..82fbcd6e 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Interface.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Interface.md @@ -4,7 +4,7 @@ topic: core-StandardPattern-Endpoint-Interface-1.3.0 # Interface -The Interface for managing the 3 resources relating to an "endpoint" is detailed below and is part of the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) for Core 1.2.0 and above. +The Interface for managing the 3 resources relating to an "endpoint" is detailed below and is part of the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) for Core 1.2.0 and above. ## Request and Response diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Introduction.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Introduction.md index 8c176ab2..3fa5c00a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Introduction.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/EndpointCatalogue-StandardPattern/Introduction.md @@ -27,7 +27,7 @@ This version of core is strictly a preview of what is currently in development f # Standard Pattern - Endpoints -BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) The following pages will describe how these entries can be managed, outside of the onboarding process. +BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) The following pages will describe how these entries can be managed, outside of the onboarding process. The BaRS endpoints will utilise not only service ids and a physical endpoint, but data describing the healthcare service, the provider of that service and the organization which manages and/or supplies the endpoint in question. This information will be stored using 3 FHIR resources which appropriately describe [Endpoints](http://hl7.org/fhir/R4/endpoint.html), [HealthcareServices](http://hl7.org/fhir/R4/healthcareservice.html) and [Organizations](http://hl7.org/fhir/R4/organization.html). diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Index.page.md index 1151567b..f1de134b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Index.page.md @@ -15,7 +15,7 @@ topic: design-core-1.3.0 v1.3.0 v1.8.2 - v1.3.0 + v1.3.0 @@ -245,7 +245,7 @@ This version of core is strictly a preview of what is currently in development f -BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) The following pages will describe how these entries can be managed, outside of the onboarding process. +BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) The following pages will describe how these entries can be managed, outside of the onboarding process. The BaRS endpoints will utilise not only service ids and a physical endpoint, but data describing the healthcare service, the provider of that service and the organization which manages and/or supplies the endpoint in question. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Standard-Pattern-Composite-Messages/Cancellation.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Standard-Pattern-Composite-Messages/Cancellation.page.md index 5af822fe..79c003e8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Standard-Pattern-Composite-Messages/Cancellation.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Standard-Pattern-Composite-Messages/Cancellation.page.md @@ -7,7 +7,7 @@ topic: core-SPCancellation-1.3.0 The ability to reverse a digital request, by performing a cancellation, whether booking or referral, is a core workflow within BaRS. It completes the digital workflow, supports genuine interoperability and removes the need for manual intervention by service providers. -There are two potential routes for performing a cancellation of a booking or referral, dependending on Supplier implementation (see - Capability Statement (GET /metadata) for supported methods), either via $process-message or directly against the single resource (RESTfully). Where $process-message is used a stripped back request containing only the specific resources a Receiver requires to the fulfil the update are included. There are separate MessageDefinitions involved when engaged in the respective [referral](https://simplifier.net/nhsbookingandreferrals/messagedefinition-barsmessagedefinitionservicerequestrequestcancelled/~json) and [booking](https://simplifier.net/NHSBookingandReferrals/MessageDefinition-BARSMessageDefinitionBookingRequestCancelled/~json) cancellation workflows. Alternatively, where a RESTful pattern for updating a single resource is followed, the independent endpoints for [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) and [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/ServiceRequest/-id-) support the update process. This workflow follows {{pagelink:core-StandardPattern-appointment-1.3.0 , text:Standard Pattern - Appointments}}. +There are two potential routes for performing a cancellation of a booking or referral, dependending on Supplier implementation (see - Capability Statement (GET /metadata) for supported methods), either via $process-message or directly against the single resource (RESTfully). Where $process-message is used a stripped back request containing only the specific resources a Receiver requires to the fulfil the update are included. There are separate MessageDefinitions involved when engaged in the respective [referral](https://simplifier.net/nhsbookingandreferrals/messagedefinition-barsmessagedefinitionservicerequestrequestcancelled/~json) and [booking](https://simplifier.net/NHSBookingandReferrals/MessageDefinition-BARSMessageDefinitionBookingRequestCancelled/~json) cancellation workflows. Alternatively, where a RESTful pattern for updating a single resource is followed, the independent endpoints for [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) and [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/ServiceRequest/-id-) support the update process. This workflow follows {{pagelink:core-StandardPattern-appointment-1.3.0 , text:Standard Pattern - Appointments}}. It is a prerequisite, when performing a cancellation, to read (GET) the booking or referral to be cancelled, following the {{pagelink:core-SPFindResource-1.3.0, text:find resource}} steps. This ensures the Sender has the key values to build the request and verifies they can proceed with the workflow. The Sender **must** only make a cancellation request if the entity being cancelled has a status which means it is still current; 'active' in the case of a referral (ServiceRequest) and 'booked' for a booking (Appointment). This ensures the Sender has the latest version of the resource they are about to change or, if it is no longer current (because its been actioned by the Receiver), allows the Sender to advise the end user so an alternative (often manual) workflow can be started. The Receiver **must not** process a cancellation request for a booking or referral which is not current, instead they **must** return an appropriate {{pagelink:core-ErrorHandling-1.3.0, text:error}} response. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Transactional-integrity/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Transactional-integrity/Introduction.page.md index 67fbd9cb..cc906c13 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Transactional-integrity/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Transactional-integrity/Introduction.page.md @@ -6,7 +6,7 @@ topic: Core-TransactionalIntegrity-Introduction-1.3.0 Transactional integrity is employed to ensure data integrity is maintained between two parties. It helps ensure that the success or failure of a message is known and can be confirmed. -There are two existing header items for requests currently available to allow BaRS to meet transactional integrity requirements. They are listed below with their intended uses. The [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) contains example values for these entries. +There are two existing header items for requests currently available to allow BaRS to meet transactional integrity requirements. They are listed below with their intended uses. The [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) contains example values for these entries. | Header | Requirement | Description | Value | |------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Cancel-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Cancel-Booking.page.md index 46343996..d839b4fb 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Cancel-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Cancel-Booking.page.md @@ -8,10 +8,10 @@ Cancellation is documented for completeness. The technical functionality for can Steps to cancel: -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually * Set the Appointment.status value to "cancelled". NB - It is also permissible to update .reasonCode in the request but no other element -* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} -* Once processed, the Receiver of the booking must [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#delete-/DocumentReference/-id-) the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}} +* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Once processed, the Receiver of the booking must [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#delete-/DocumentReference/-id-) the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}} resource returned: ```json diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Initial-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Initial-Booking.page.md index fca086fd..1881e11e 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Initial-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Initial-Booking.page.md @@ -9,16 +9,16 @@ Below are examples of each of the described interactions. The appointment resour Any operations that modify an existing resource must perform a read before a write, as outlined below. ### Book -Making an initial booking through Appointment Management Foundation, outside of the prescribed BaRS Applications, must follow the workflow outlined using the discete [booking endpoints](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment). +Making an initial booking through Appointment Management Foundation, outside of the prescribed BaRS Applications, must follow the workflow outlined using the discete [booking endpoints](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment). -If undertaking a booking within the context of an Application, the guidance stated there takes precedence over this documentation. NB: BaRS Applications are likely to utilise the [$process-message](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/$process-message) endpoint (contact BaRS Team for guidance on use outside of the published Applications - ), rather than independent resources. Steps to perform an initial booking: +If undertaking a booking within the context of an Application, the guidance stated there takes precedence over this documentation. NB: BaRS Applications are likely to utilise the [$process-message](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/$process-message) endpoint (contact BaRS Team for guidance on use outside of the published Applications - ), rather than independent resources. Steps to perform an initial booking: * {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.3.1, text:Select the service}} to book an appointment with -* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/metadata) -* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot) +* Confirm BaRS [Capabilities](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/metadata) +* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot) * Select a slot -* Perform a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) operation to complete the booking NB: the returned Appointment.id for future operations -* Once processed, the Receiver of the booking must make a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/DocumentReference) request to create a pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}} +* Perform a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) operation to complete the booking NB: the returned Appointment.id for future operations +* Once processed, the Receiver of the booking must make a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/DocumentReference) request to create a pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}} Request Body diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md index 0707650f..b3e11a79 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md @@ -10,7 +10,7 @@ topic: core-StandardPattern-appointment-Introduction-1.3.1 ## Introduction -The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). +The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/). This includes using {{pagelink:core-StandardPattern-document-reference-1.3.1, text: Standard Pattern DocumentReference}} to write pointers for bookings to a central repository, commonly referred to as the Registry. @@ -32,19 +32,19 @@ The ability to - ## Interface -The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| -| [List](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference) | /DocumentReference | GET | Using the {{pagelink:core-StandardPattern-document-reference-Introduction-1.3.1, text:DocumentReference}} pattern, a list of existing appointments for a patient can be viewed with the central Registry. | -| [View](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) | /Appointment/\{id\} | GET | This action, using the id from the List capability, will allow that specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) from the healthcare service who owns it. | -| [View (Search)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment) | /Appointment | GET | If the Appointment.id is not known, the Sender can perform a look up based the patient national identifier (NHS No.) or demographics (Name (as defined by [FHIR](https://simplifier.net/packages/hl7.fhir.r4.core/4.0.1/files/2834389 )), Date of Birth, Home Address Postcode). This returns a (FHIR) bundle of resources for the specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment) from the healthcare service who owns it. See {{pagelink:core-SPCancellation-1.3.1, text:Cancellation}} for further detail.| -| [Get Slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot) | /Slots | GET | Obtain a list of available booking slots from a specified receiving system using the [GET /Slots endpoint](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot) | -| [Book](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) | /Appointment or /$process-message | POST | This will be a POST operation, with a BaRS Application /$process-message is typically used, outside of supported use cases /Appointment is adopted.| -| [Cancel](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) | /Appointment/\{id\} | PUT| The cancel of a booking will be setting the status of the appointment to "cancelled". Cancel is also possible using /$process-message | -| [Update](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) | /Appointment/\{id\} | PUT| An update to an appointment will be a direct update to the existing resource | -| [Reschedule](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) | /Appointment/\{id\} | PATCH| An update the slot against an appointment, altering to the existing resource | -| [Rebook](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) | Composite of Cancel and then Book | Composite | Requesting a new booking and then cancelling the existing one will constitute a rebook | - - -In line with the BaRS standard all operations used to modify a resource must be preceded by a read of the resource by means of a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation. +| [List](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/DocumentReference) | /DocumentReference | GET | Using the {{pagelink:core-StandardPattern-document-reference-Introduction-1.3.1, text:DocumentReference}} pattern, a list of existing appointments for a patient can be viewed with the central Registry. | +| [View](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) | /Appointment/\{id\} | GET | This action, using the id from the List capability, will allow that specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) from the healthcare service who owns it. | +| [View (Search)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment) | /Appointment | GET | If the Appointment.id is not known, the Sender can perform a look up based the patient national identifier (NHS No.) or demographics (Name (as defined by [FHIR](https://simplifier.net/packages/hl7.fhir.r4.core/4.0.1/files/2834389 )), Date of Birth, Home Address Postcode). This returns a (FHIR) bundle of resources for the specific Appointment Resource to be [retrieved](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment) from the healthcare service who owns it. See {{pagelink:core-SPCancellation-1.3.1, text:Cancellation}} for further detail.| +| [Get Slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot) | /Slots | GET | Obtain a list of available booking slots from a specified receiving system using the [GET /Slots endpoint](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot) | +| [Book](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) | /Appointment or /$process-message | POST | This will be a POST operation, with a BaRS Application /$process-message is typically used, outside of supported use cases /Appointment is adopted.| +| [Cancel](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) | /Appointment/\{id\} | PUT| The cancel of a booking will be setting the status of the appointment to "cancelled". Cancel is also possible using /$process-message | +| [Update](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) | /Appointment/\{id\} | PUT| An update to an appointment will be a direct update to the existing resource | +| [Reschedule](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) | /Appointment/\{id\} | PATCH| An update the slot against an appointment, altering to the existing resource | +| [Rebook](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) | Composite of Cancel and then Book | Composite | Requesting a new booking and then cancelling the existing one will constitute a rebook | + + +In line with the BaRS standard all operations used to modify a resource must be preceded by a read of the resource by means of a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Rebook-Methods.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Rebook-Methods.page.md index a3b57f25..3d5e0451 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Rebook-Methods.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Rebook-Methods.page.md @@ -7,13 +7,13 @@ topic: core-StandardPattern-appointment-rebook-1.3.1 FHIR Guidance for [Rebook](https://hl7.org/fhir/R4/appointment.html) #### Process for rebook -Rebooking through Appointment Management Foundation, outside of a prescribed BaRS Applications, must follow the workflow outlined. If undertaking a rebook within the context of an Application, the guidance stated there takes precedence over this documentation. NB: BaRS Applications are likely to utilise the [$process-message](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/$process-message) endpoint (contact BaRS Team for guidance on use of $process-message, outside of the published Applications), rather than independent resources. +Rebooking through Appointment Management Foundation, outside of a prescribed BaRS Applications, must follow the workflow outlined. If undertaking a rebook within the context of an Application, the guidance stated there takes precedence over this documentation. NB: BaRS Applications are likely to utilise the [$process-message](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/$process-message) endpoint (contact BaRS Team for guidance on use of $process-message, outside of the published Applications), rather than independent resources. Steps to perform a rebook: * {{pagelink:core-StandardPattern-appointment-cancel-1.3.1, text:Cancel existing booking}} * {{pagelink:core-StandardPattern-appointment-booking-1.3.1, text:Rebook, following the initial booking workflow}} -* Once processed, the Receiver of the new booking must make a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/DocumentReference) request to create a new pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}} +* Once processed, the Receiver of the new booking must make a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/DocumentReference) request to create a new pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}} diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md index e9bf589c..cc8d9fc4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Reschedule-Existing-Booking.page.md @@ -8,12 +8,12 @@ The Reschedule operation supports amending the slot a booking is made against. T Steps to Reschedule: -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually -* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Slot) from the service +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually +* [Request Available slots](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Slot) from the service * Select a new slot * Update the resource with the new slot. NB: Only the .slot element of the resource must be updated -* Perform a [PATCH](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#patch-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} -* Once processed, the Receiver of the booking must [update (PUT)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/DocumentReference/-id-) the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}}. The principal update to the pointer is to change the .context element to alter the slot time - +* Perform a [PATCH](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#patch-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Once processed, the Receiver of the booking must [update (PUT)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/DocumentReference/-id-) the pointer in the central Registry, as described in {{pagelink:core-StandardPattern-document-reference-Receiver-1.3.1, text: Document Reference Standard Pattern - Receiver}}. The principal update to the pointer is to change the .context element to alter the slot time - ```json "context": { diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Update-Existing-Booking.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Update-Existing-Booking.page.md index 2fa3f5ef..43389da1 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Update-Existing-Booking.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Update-Existing-Booking.page.md @@ -6,9 +6,9 @@ topic: core-StandardPattern-appointment-update-1.3.1 Steps to update: -* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually +* Perform a [GET](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) operation using the .id of the appointment to /Appointment/\{id\}. Alternatively, if the .id is not known, a search of the Registry can be undertaken following the {{pagelink:core-StandardPattern-document-reference-Sender-1.3.1, text: Document Reference Standard Pattern - Sender}}. NB: If a match cannot be obtained using this method the process of updating must be performed manually * Update the Appointment resource as required. There is only currently support to alter .status and .reasonCode. NB: The .slot element of the resource must not be updated, if an alternative slot is required either the {{pagelink:core-StandardPattern-appointment-reschedule-1.3.1, text:Reschedule}} or {{pagelink:core-StandardPattern-appointment-rebook-1.3.1, text:Rebook}} processes must be followed -* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} +* Perform a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) operation using the id of the appointment to /Appointment/\{id\} resource returned: ```json @@ -26,7 +26,7 @@ resource returned: { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165342003", "display": "Patient declined laboratory test (situation)" } @@ -63,7 +63,7 @@ Request Body { "coding": [ { - "system": "http://snomed.info/sct", + "system": "https://termbrowser.nhs.uk", "code": "165332000", "display": "Laboratory test requested (situation)" } diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index 8d2e6fe1..8f3fed3d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | https://termbrowser.nhs.uk|736253002 | Filter by Appointment or ServiceRequesr | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md index 0c4b307b..b623e853 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Receiver-DocumentReference.md @@ -10,7 +10,7 @@ The FHIR DocumentReference resource allows you to create a reference to a clinic ### Step 1: Identify the booking or referral to create a pointer for -When a Receiver processes a request for a booking (Appointment) or referral (ServiceRequest), the next step in the workflow is to create a pointer for the newly created resource (Appointment or ServiceRequest) on the central Registry. This will be undertaken via a POST [DocumentReference](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/DocumentReference) request to the BaRS Proxy. +When a Receiver processes a request for a booking (Appointment) or referral (ServiceRequest), the next step in the workflow is to create a pointer for the newly created resource (Appointment or ServiceRequest) on the central Registry. This will be undertaken via a POST [DocumentReference](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/DocumentReference) request to the BaRS Proxy. ### Step 2: Set content of the DocumentReference (pointer) @@ -28,7 +28,7 @@ The resource .id of the booking (Appointment) or referral (ServiceRequest) (crea } ``` -The second identifier of note is the Receiving service who own the resource. The 'system' indicates the Service Discovery tool and the 'value', the identifier. In the code snippet below, the system '*https://fhir.nhs.uk/Id/dos-service-id*' indicates the Receiver service is on the Urgent and Emergency Care Directory of Services (UEC DoS) as service 2000072491. The Sender of any request will use the 'system' and 'value' here to build the base64 encoded HTTP Header NHSD-Target-Identifier, as defined for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest/-id-). +The second identifier of note is the Receiving service who own the resource. The 'system' indicates the Service Discovery tool and the 'value', the identifier. In the code snippet below, the system '*https://fhir.nhs.uk/Id/dos-service-id*' indicates the Receiver service is on the Urgent and Emergency Care Directory of Services (UEC DoS) as service 2000072491. The Sender of any request will use the 'system' and 'value' here to build the base64 encoded HTTP Header NHSD-Target-Identifier, as defined for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/ServiceRequest/-id-). ```json "identifier": [ @@ -95,20 +95,20 @@ The third identifier (currently optional) relates to the product-id, system '*ht ``` ### Step 3: Save and Transmit the DocumentReference (pointer) -Once all the necessary fields are populated, perform a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/DocumentReference) of the DocumentReference to the /DocumentReference endpoint on the BaRS proxy. This will create a DocumentReference in the NRL. +Once all the necessary fields are populated, perform a [POST](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/DocumentReference) of the DocumentReference to the /DocumentReference endpoint on the BaRS proxy. This will create a DocumentReference in the NRL. -After saving, the DocumentReference will be assigned a unique id (e.g., DocumentReference/12345). This can be used to reference or [retrieve](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference/-id-) the DocumentReference in the future. +After saving, the DocumentReference will be assigned a unique id (e.g., DocumentReference/12345). This can be used to reference or [retrieve](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/DocumentReference/-id-) the DocumentReference in the future. ### Step 4: Verify the DocumentReference -To ensure that the DocumentReference was created successfully, retrieve it using its [id](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference/-id-) or [search](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference) for it using relevant parameters. Make sure to validate the returned DocumentReference to confirm that all the contents are accurate. +To ensure that the DocumentReference was created successfully, retrieve it using its [id](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/DocumentReference/-id-) or [search](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/DocumentReference) for it using relevant parameters. Make sure to validate the returned DocumentReference to confirm that all the contents are accurate. ### Updating a DocumentReference -A DocumentReference can be updated by performing a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/DocumentReference/-id-) request with the updated resource to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A read operation must be performed prior to this to ensure that the new DocumentReference is the most up to date. +A DocumentReference can be updated by performing a [PUT](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/DocumentReference/-id-) request with the updated resource to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A read operation must be performed prior to this to ensure that the new DocumentReference is the most up to date. **Note**: A Receiver can only update DocumentReference resources that they created and own. ### Delete a DocumentReference -A DocumentReference can be removed by performing a [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#delete-/DocumentReference/-id-) request to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A read operation must be performed prior to this to ensure that the action is appropriate. +A DocumentReference can be removed by performing a [DELETE](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#delete-/DocumentReference/-id-) request to the /DocumentReference endpoint on the BaRS proxy with the appropriate DocumentReference.id. A read operation must be performed prior to this to ensure that the action is appropriate. **Note**: A Receiver can only delete DocumentReference resources they created and own. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md index de867509..4be814ef 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/DocumentReference-StandardPattern/Sender-DocumentReference.md @@ -8,7 +8,7 @@ topic: core-StandardPattern-document-reference-Sender-1.3.1 The FHIR DocumentReference resource represents a reference to a clinical document or resource, in the case of BaRS a pointer to an active booking or referral. It contains metadata about the booking or referral, such as its type (booking or referral), author, and subject (the patient's NHS number), as well as a reference to the actual document's .id and where it resides (the service who owns it); the two key data points needed to retrieve it. ### Step 2: Search for the booking or referral pointer (DocumentReference) -FHIR DocumentReference resources holding pointers for BaRS bookings and referrals are stored in a central Registry, within NRL (National Record Locator), as decribed above, and interrogated through the [BaRS API DocumentReference](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/DocumentReference). +FHIR DocumentReference resources holding pointers for BaRS bookings and referrals are stored in a central Registry, within NRL (National Record Locator), as decribed above, and interrogated through the [BaRS API DocumentReference](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/DocumentReference). To find a booking or referral location, you need to search for the appropriate DocumentReference resource from the Registry, using search parameters. It is mandatory to include the subject:identifier (the patient's NHS number). Other parameters can be used to filter the response further e.g type of document (booking and referral). @@ -17,7 +17,7 @@ Once you retrieve the Document Reference(s) (pointers) from the search, inspect **identifier:** The DocumentReference will have several identifiers which are required to locate the booking or referral at a Receiver service. -The .id of the booking or referral is indicated by the system '*https://fhir.nhs.uk/Id/BaRS-Identifier*'. The value can be used to directly request the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest/-id-) by .id, once you know Receiver service holding it (see next identifier). +The .id of the booking or referral is indicated by the system '*https://fhir.nhs.uk/Id/BaRS-Identifier*'. The value can be used to directly request the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/ServiceRequest/-id-) by .id, once you know Receiver service holding it (see next identifier). ```json "identifier": [ @@ -27,7 +27,7 @@ The .id of the booking or referral is indicated by the system '*https://fhir.nhs } ``` -The second identifier, required to make the subsequent request for the booking or referral in question, has a system of '*https://fhir.nhs.uk/Id/dos-service-id*' and enables the Sender to direct their request to the Receiver service which owns it. The Sender will use the system and value here to build the base64 encoded HTTP Header NHSD-Target-Identifier, as defined for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest/-id-). +The second identifier, required to make the subsequent request for the booking or referral in question, has a system of '*https://fhir.nhs.uk/Id/dos-service-id*' and enables the Sender to direct their request to the Receiver service which owns it. The Sender will use the system and value here to build the base64 encoded HTTP Header NHSD-Target-Identifier, as defined for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/ServiceRequest/-id-). ```json "identifier": [ @@ -47,7 +47,7 @@ The third identifier (currently optional) relates to the product-id, system '*ht } ``` -**type:** within the DocumentReference Resource, indicates whether the pointer is for a booking or referral. BaRS currently only supports bookings (749001000000101) and referrals (736253002), described using SNOMED codes. This information is required to direct the subsequent request to the correct endpoint for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest/-id-) +**type:** within the DocumentReference Resource, indicates whether the pointer is for a booking or referral. BaRS currently only supports bookings (749001000000101) and referrals (736253002), described using SNOMED codes. This information is required to direct the subsequent request to the correct endpoint for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/ServiceRequest/-id-) ```json "type": { @@ -61,7 +61,7 @@ The third identifier (currently optional) relates to the product-id, system '*ht } ``` -**subject:** The subject will describe the patient, by means of an NHS number. This element is not explicitly required to request the specific resource dictated by the pointer but could be used to search a service more widely for related [bookings](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment) and [referrals](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest), using the search by patient endpoints. +**subject:** The subject will describe the patient, by means of an NHS number. This element is not explicitly required to request the specific resource dictated by the pointer but could be used to search a service more widely for related [bookings](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment) and [referrals](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/ServiceRequest), using the search by patient endpoints. ```json "subject": { @@ -94,7 +94,7 @@ The third identifier (currently optional) relates to the product-id, system '*ht ``` ### Step 4: Retrieve the booking or referral -The booking or referral resource can be retrieved by making a GET request for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/ServiceRequest/-id-). +The booking or referral resource can be retrieved by making a GET request for the [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/Appointment/-id-) or [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#get-/ServiceRequest/-id-). The two key values required to make the request are the first two identifiers in the DocumentReference; the resource .id ('*https://fhir.nhs.uk/Id/BaRS-Identifier*') and service id ('*https://fhir.nhs.uk/Id/dos-service-id*'). Use the resource .id populate the location of the request and service id to populate the NHSD-Target-Identifier HTTP Header, as described in the worked example below. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/BaRS-FHIR-API.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/BaRS-FHIR-API.page.md index a65cf4b1..1d64b320 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/BaRS-FHIR-API.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/BaRS-FHIR-API.page.md @@ -4,11 +4,11 @@ topic: core-EndToEndWorkflow-API-1.3.1 ## BaRS FHIR API -The [BaRS FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) supports all functionality with receiver APIs for both booking and referrals. Once an access token has been obtained, the sender can start making requests of the API. +The [BaRS FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) supports all functionality with receiver APIs for both booking and referrals. Once an access token has been obtained, the sender can start making requests of the API. Note: With every API request the sender must include the HTTP header parameter 'NHSD-Target Identifier'. -You can find details for each endpoint in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). +You can find details for each endpoint in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/).

\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/HTTP-Header.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/HTTP-Header.page.md index 7bc6059b..b63e24cc 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/HTTP-Header.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/End-to-end-workflow/HTTP-Header.page.md @@ -5,7 +5,7 @@ topic: core-EndToEndWorkflow-HTTPHeader-1.3.1 ## {{page-title}} -The BaRS API specifies several additional headers, many of which are items described in a standard Base64 encoded object (JSON). Their purpose and usage are described below. Examples can be found in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). +The BaRS API specifies several additional headers, many of which are items described in a standard Base64 encoded object (JSON). Their purpose and usage are described below. Examples can be found in the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/).

\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Interface.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Interface.md index 127a62b3..ea4e77e7 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Interface.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Interface.md @@ -4,7 +4,7 @@ topic: core-StandardPattern-Endpoint-Interface-1.3.1 # Interface -The Interface for managing the 3 resources relating to an "endpoint" is detailed below and is part of the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) for Core 1.2.0 and above. +The Interface for managing the 3 resources relating to an "endpoint" is detailed below and is part of the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) for Core 1.2.0 and above. ## Request and Response diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Introduction.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Introduction.md index e6a40a58..2f7a6380 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Introduction.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/EndpointCatalogue-StandardPattern/Introduction.md @@ -27,7 +27,7 @@ This version of core is strictly a preview of what is currently in development f # Standard Pattern - Endpoints -BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) The following pages will describe how these entries can be managed, outside of the onboarding process. +BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) The following pages will describe how these entries can be managed, outside of the onboarding process. The BaRS endpoints will utilise not only service ids and a physical endpoint, but data describing the healthcare service, the provider of that service and the organization which manages and/or supplies the endpoint in question. This information will be stored using 3 FHIR resources which appropriately describe [Endpoints](http://hl7.org/fhir/R4/endpoint.html), [HealthcareServices](http://hl7.org/fhir/R4/healthcareservice.html) and [Organizations](http://hl7.org/fhir/R4/organization.html). diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Index.page.md index 8e0bd663..5af4ee07 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Index.page.md @@ -15,7 +15,7 @@ topic: design-core-1.3.1 v1.3.1 v1.10.0 - v1.3.0 + v1.3.0 @@ -247,7 +247,7 @@ This version of core is strictly a preview of what is currently in development f -BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) The following pages will describe how these entries can be managed, outside of the onboarding process. +BaRS employs an endpoint catalogue to match Target Identifiers with a stored endpoint. Target Identifiers are provided in a header which is descripted in the [API Spec](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) The following pages will describe how these entries can be managed, outside of the onboarding process. The BaRS endpoints will utilise not only service ids and a physical endpoint, but data describing the healthcare service, the provider of that service and the organization which manages and/or supplies the endpoint in question. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Standard-Pattern-Composite-Messages/Cancellation.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Standard-Pattern-Composite-Messages/Cancellation.page.md index 35212ae2..ae86a59c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Standard-Pattern-Composite-Messages/Cancellation.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Standard-Pattern-Composite-Messages/Cancellation.page.md @@ -7,7 +7,7 @@ topic: core-SPCancellation-1.3.1 The ability to reverse a digital request, by performing a cancellation, whether booking or referral, is a core workflow within BaRS. It completes the digital workflow, supports genuine interoperability and removes the need for manual intervention by service providers. -There are two potential routes for performing a cancellation of a booking or referral, dependending on Supplier implementation (see - Capability Statement (GET /metadata) for supported methods), either via $process-message or directly against the single resource (RESTfully). Where $process-message is used a stripped back request containing only the specific resources a Receiver requires to the fulfil the update are included. There are separate MessageDefinitions involved when engaged in the respective [referral](https://simplifier.net/nhsbookingandreferrals/messagedefinition-barsmessagedefinitionservicerequestrequestcancelled/~json) and [booking](https://simplifier.net/NHSBookingandReferrals/MessageDefinition-BARSMessageDefinitionBookingRequestCancelled/~json) cancellation workflows. Alternatively, where a RESTful pattern for updating a single resource is followed, the independent endpoints for [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) and [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/ServiceRequest/-id-) support the update process. This workflow follows {{pagelink:core-StandardPattern-appointment-1.3.1 , text:Standard Pattern - Appointments}}. +There are two potential routes for performing a cancellation of a booking or referral, dependending on Supplier implementation (see - Capability Statement (GET /metadata) for supported methods), either via $process-message or directly against the single resource (RESTfully). Where $process-message is used a stripped back request containing only the specific resources a Receiver requires to the fulfil the update are included. There are separate MessageDefinitions involved when engaged in the respective [referral](https://simplifier.net/nhsbookingandreferrals/messagedefinition-barsmessagedefinitionservicerequestrequestcancelled/~json) and [booking](https://simplifier.net/NHSBookingandReferrals/MessageDefinition-BARSMessageDefinitionBookingRequestCancelled/~json) cancellation workflows. Alternatively, where a RESTful pattern for updating a single resource is followed, the independent endpoints for [booking](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) and [referral](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/ServiceRequest/-id-) support the update process. This workflow follows {{pagelink:core-StandardPattern-appointment-1.3.1 , text:Standard Pattern - Appointments}}. It is a prerequisite, when performing a cancellation, to read (GET) the booking or referral to be cancelled, following the {{pagelink:core-SPFindResource-1.3.1, text:find resource}} steps. This ensures the Sender has the key values to build the request and verifies they can proceed with the workflow. The Sender **must** only make a cancellation request if the entity being cancelled has a status which means it is still current; 'active' in the case of a referral (ServiceRequest) and 'booked' for a booking (Appointment). This ensures the Sender has the latest version of the resource they are about to change or, if it is no longer current (because its been actioned by the Receiver), allows the Sender to advise the end user so an alternative (often manual) workflow can be started. The Receiver **must not** process a cancellation request for a booking or referral which is not current, instead they **must** return an appropriate {{pagelink:core-ErrorHandling-1.3.1, text:error}} response. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Transactional-integrity/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Transactional-integrity/Introduction.page.md index 34781d87..ce5098a8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Transactional-integrity/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Transactional-integrity/Introduction.page.md @@ -6,7 +6,7 @@ topic: Core-TransactionalIntegrity-Introduction-1.3.1 Transactional integrity is employed to ensure data integrity is maintained between two parties. It helps ensure that the success or failure of a message is known and can be confirmed. -There are two existing header items for requests currently available to allow BaRS to meet transactional integrity requirements. They are listed below with their intended uses. The [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) contains example values for these entries. +There are two existing header items for requests currently available to allow BaRS to meet transactional integrity requirements. They are listed below with their intended uses. The [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/) contains example values for these entries. | Header | Requirement | Description | Value | |------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.page.md index cdf208b3..02507274 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Technical-deployment/BaRSEndpointCatalogue.page.md @@ -8,7 +8,7 @@ Every service receiving messages through BaRS will need their ServiceId and endp When a Sender wants to send a booking or referral using the BaRS Proxy, they will use a Service Discovery tool and select the Receiver's service in their system. -The Sender will include the ServiceId for the selected service in the HTTP Headers [NHSD-Target-identifier](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#overview--overview) it sends to the BaRS Proxy. +The Sender will include the ServiceId for the selected service in the HTTP Headers [NHSD-Target-identifier](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#overview--overview) it sends to the BaRS Proxy. The BaRS Proxy uses the ServiceId in the HTTP Header to reference the BaRS Endpoint Catalogue, find the specific endpoint for the service and transport the message to the correct destination.