diff --git a/baseline/about-me-chrome-1200x900-dpr-1.png b/baseline/about-me-chrome-1200x900-dpr-1.png index bf4efa5..6262393 100644 Binary files a/baseline/about-me-chrome-1200x900-dpr-1.png and b/baseline/about-me-chrome-1200x900-dpr-1.png differ diff --git a/baseline/accessible-information-chrome-1200x900-dpr-1.png b/baseline/accessible-information-chrome-1200x900-dpr-1.png index 043e9e9..e7f68d2 100644 Binary files a/baseline/accessible-information-chrome-1200x900-dpr-1.png and b/baseline/accessible-information-chrome-1200x900-dpr-1.png differ diff --git a/baseline/aggregate-contract-monitoring-chrome-1200x900-dpr-1.png b/baseline/aggregate-contract-monitoring-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..cb175c7 Binary files /dev/null and b/baseline/aggregate-contract-monitoring-chrome-1200x900-dpr-1.png differ diff --git a/baseline/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png b/baseline/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png index 913f6b4..fc0538d 100644 Binary files a/baseline/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png and b/baseline/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png differ diff --git a/baseline/aidc-for-patient-identification-chrome-1200x900-dpr-1.png b/baseline/aidc-for-patient-identification-chrome-1200x900-dpr-1.png index 00b3869..722199e 100644 Binary files a/baseline/aidc-for-patient-identification-chrome-1200x900-dpr-1.png and b/baseline/aidc-for-patient-identification-chrome-1200x900-dpr-1.png differ diff --git a/baseline/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png b/baseline/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png index a30ba2f..9ec094a 100644 Binary files a/baseline/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png and b/baseline/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png differ diff --git a/baseline/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png b/baseline/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png index 2da6ebc..73548a4 100644 Binary files a/baseline/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png and b/baseline/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png differ diff --git a/baseline/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png b/baseline/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png index 1033ea7..40f5cc6 100644 Binary files a/baseline/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png b/baseline/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png index c0afd8f..c47a529 100644 Binary files a/baseline/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png and b/baseline/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png differ diff --git a/baseline/assuring-transformation-chrome-1200x900-dpr-1.png b/baseline/assuring-transformation-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..1d840d3 Binary files /dev/null and b/baseline/assuring-transformation-chrome-1200x900-dpr-1.png differ diff --git a/baseline/birth-notifications-chrome-1200x900-dpr-1.png b/baseline/birth-notifications-chrome-1200x900-dpr-1.png index cdb109c..445c656 100644 Binary files a/baseline/birth-notifications-chrome-1200x900-dpr-1.png and b/baseline/birth-notifications-chrome-1200x900-dpr-1.png differ diff --git a/baseline/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png b/baseline/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png index 02ca94a..d905b66 100644 Binary files a/baseline/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png and b/baseline/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/cancer-outcomes-and-services-data-set-chrome-1200x900-dpr-1.png b/baseline/cancer-outcomes-and-services-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..f1ad73c Binary files /dev/null and b/baseline/cancer-outcomes-and-services-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png b/baseline/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png index c666177..d7a0ac0 100644 Binary files a/baseline/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png and b/baseline/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png b/baseline/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png index dd4c3d5..23d9ca9 100644 Binary files a/baseline/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png and b/baseline/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png differ diff --git a/baseline/child-protection-information-sharing-chrome-1200x900-dpr-1.png b/baseline/child-protection-information-sharing-chrome-1200x900-dpr-1.png index 981156a..d6fdd2a 100644 Binary files a/baseline/child-protection-information-sharing-chrome-1200x900-dpr-1.png and b/baseline/child-protection-information-sharing-chrome-1200x900-dpr-1.png differ diff --git a/baseline/child-protection-information-sharing-smsp-api-standards-chrome-1200x900-dpr-1.png b/baseline/child-protection-information-sharing-smsp-api-standards-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..7150514 Binary files /dev/null and b/baseline/child-protection-information-sharing-smsp-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/chlamydia-testing-activity-dataset-chrome-1200x900-dpr-1.png b/baseline/chlamydia-testing-activity-dataset-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..9e80f86 Binary files /dev/null and b/baseline/chlamydia-testing-activity-dataset-chrome-1200x900-dpr-1.png differ diff --git a/baseline/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png b/baseline/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png index 5f43cec..c639032 100644 Binary files a/baseline/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png and b/baseline/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/clinical-referral-information-chrome-1200x900-dpr-1.png b/baseline/clinical-referral-information-chrome-1200x900-dpr-1.png index 5417d00..56d0d6f 100644 Binary files a/baseline/clinical-referral-information-chrome-1200x900-dpr-1.png and b/baseline/clinical-referral-information-chrome-1200x900-dpr-1.png differ diff --git a/baseline/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png b/baseline/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png index ed76917..f9438e6 100644 Binary files a/baseline/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png and b/baseline/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png differ diff --git a/baseline/commissioning-data-sets-cds-chrome-1200x900-dpr-1.png b/baseline/commissioning-data-sets-cds-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..9e80f86 Binary files /dev/null and b/baseline/commissioning-data-sets-cds-chrome-1200x900-dpr-1.png differ diff --git a/baseline/commissioning-data-sets-emergency-care-data-set-chrome-1200x900-dpr-1.png b/baseline/commissioning-data-sets-emergency-care-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..785e0d6 Binary files /dev/null and b/baseline/commissioning-data-sets-emergency-care-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/community-pharmacy-chrome-1200x900-dpr-1.png b/baseline/community-pharmacy-chrome-1200x900-dpr-1.png index eb645a8..0be3b01 100644 Binary files a/baseline/community-pharmacy-chrome-1200x900-dpr-1.png and b/baseline/community-pharmacy-chrome-1200x900-dpr-1.png differ diff --git a/baseline/community-services-data-set-chrome-1200x900-dpr-1.png b/baseline/community-services-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..7ae7c34 Binary files /dev/null and b/baseline/community-services-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png b/baseline/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png index 0a64445..2268bf7 100644 Binary files a/baseline/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png and b/baseline/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png differ diff --git a/baseline/consultant-led-referral-to-treatment-waiting-times-chrome-1200x900-dpr-1.png b/baseline/consultant-led-referral-to-treatment-waiting-times-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..ac1a9b3 Binary files /dev/null and b/baseline/consultant-led-referral-to-treatment-waiting-times-chrome-1200x900-dpr-1.png differ diff --git a/baseline/core-information-standard-chrome-1200x900-dpr-1.png b/baseline/core-information-standard-chrome-1200x900-dpr-1.png index 7eae0b9..5448742 100644 Binary files a/baseline/core-information-standard-chrome-1200x900-dpr-1.png and b/baseline/core-information-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/cover-of-vaccination-evaluated-rapidly-chrome-1200x900-dpr-1.png b/baseline/cover-of-vaccination-evaluated-rapidly-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..3138dd1 Binary files /dev/null and b/baseline/cover-of-vaccination-evaluated-rapidly-chrome-1200x900-dpr-1.png differ diff --git a/baseline/data-security-and-protection-toolkit-chrome-1200x900-dpr-1.png b/baseline/data-security-and-protection-toolkit-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..7335640 Binary files /dev/null and b/baseline/data-security-and-protection-toolkit-chrome-1200x900-dpr-1.png differ diff --git a/baseline/diabetes-information-record-standard-chrome-1200x900-dpr-1.png b/baseline/diabetes-information-record-standard-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..07881ad Binary files /dev/null and b/baseline/diabetes-information-record-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/diagnostic-imaging-data-set-chrome-1200x900-dpr-1.png b/baseline/diagnostic-imaging-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..7e9d9e1 Binary files /dev/null and b/baseline/diagnostic-imaging-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png b/baseline/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png index 796a060..613c342 100644 Binary files a/baseline/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png and b/baseline/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png differ diff --git a/baseline/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png b/baseline/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png index 927a283..5f7d40c 100644 Binary files a/baseline/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/digital-maternity-api-standards-chrome-1200x900-dpr-1.png b/baseline/digital-maternity-api-standards-chrome-1200x900-dpr-1.png index 60021ca..13efdb4 100644 Binary files a/baseline/digital-maternity-api-standards-chrome-1200x900-dpr-1.png and b/baseline/digital-maternity-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/digital-maternity-record-standard-chrome-1200x900-dpr-1.png b/baseline/digital-maternity-record-standard-chrome-1200x900-dpr-1.png index 5e10222..b03500c 100644 Binary files a/baseline/digital-maternity-record-standard-chrome-1200x900-dpr-1.png and b/baseline/digital-maternity-record-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/digital-medicine-fhir-chrome-1200x900-dpr-1.png b/baseline/digital-medicine-fhir-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..ddfd883 Binary files /dev/null and b/baseline/digital-medicine-fhir-chrome-1200x900-dpr-1.png differ diff --git a/baseline/document-naming-chrome-1200x900-dpr-1.png b/baseline/document-naming-chrome-1200x900-dpr-1.png index da270c2..2326727 100644 Binary files a/baseline/document-naming-chrome-1200x900-dpr-1.png and b/baseline/document-naming-chrome-1200x900-dpr-1.png differ diff --git a/baseline/dose-syntax-api-standards-chrome-1200x900-dpr-1.png b/baseline/dose-syntax-api-standards-chrome-1200x900-dpr-1.png index 494ec3c..58027c3 100644 Binary files a/baseline/dose-syntax-api-standards-chrome-1200x900-dpr-1.png and b/baseline/dose-syntax-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/edischarge-summary-chrome-1200x900-dpr-1.png b/baseline/edischarge-summary-chrome-1200x900-dpr-1.png index 26db93c..50af139 100644 Binary files a/baseline/edischarge-summary-chrome-1200x900-dpr-1.png and b/baseline/edischarge-summary-chrome-1200x900-dpr-1.png differ diff --git a/baseline/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png b/baseline/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png index dd4c4fb..c788ea6 100644 Binary files a/baseline/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png and b/baseline/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png b/baseline/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png index cf77dd0..e7f028e 100644 Binary files a/baseline/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png and b/baseline/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png differ diff --git a/baseline/emergency-care-discharge-chrome-1200x900-dpr-1.png b/baseline/emergency-care-discharge-chrome-1200x900-dpr-1.png index 470877b..0940d3c 100644 Binary files a/baseline/emergency-care-discharge-chrome-1200x900-dpr-1.png and b/baseline/emergency-care-discharge-chrome-1200x900-dpr-1.png differ diff --git a/baseline/end-of-life-api-standards-chrome-1200x900-dpr-1.png b/baseline/end-of-life-api-standards-chrome-1200x900-dpr-1.png index 0a6f018..3003d51 100644 Binary files a/baseline/end-of-life-api-standards-chrome-1200x900-dpr-1.png and b/baseline/end-of-life-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/eyecare-electronic-referral-service-api-standard-chrome-1200x900-dpr-1.png b/baseline/eyecare-electronic-referral-service-api-standard-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..c3a5266 Binary files /dev/null and b/baseline/eyecare-electronic-referral-service-api-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/female-genital-mutilation-enhanced-dataset-chrome-1200x900-dpr-1.png b/baseline/female-genital-mutilation-enhanced-dataset-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..638ff02 Binary files /dev/null and b/baseline/female-genital-mutilation-enhanced-dataset-chrome-1200x900-dpr-1.png differ diff --git a/baseline/female-genital-mutilation-information-sharing-smsp-api-standards-chrome-1200x900-dpr-1.png b/baseline/female-genital-mutilation-information-sharing-smsp-api-standards-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..9ad228a Binary files /dev/null and b/baseline/female-genital-mutilation-information-sharing-smsp-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png b/baseline/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png index fec59ed..2dc567d 100644 Binary files a/baseline/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png and b/baseline/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png b/baseline/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png index c648915..9276de8 100644 Binary files a/baseline/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png b/baseline/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png index c1c334a..08a1b2b 100644 Binary files a/baseline/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png b/baseline/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png index 7ae4219..29a36be 100644 Binary files a/baseline/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png b/baseline/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png index e2f90db..dfddadd 100644 Binary files a/baseline/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png b/baseline/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png index 065349f..b147067 100644 Binary files a/baseline/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png b/baseline/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png index dc29e13..9720f2d 100644 Binary files a/baseline/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png and b/baseline/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/gumcad-sti-surveillance-system-chrome-1200x900-dpr-1.png b/baseline/gumcad-sti-surveillance-system-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..d69ded4 Binary files /dev/null and b/baseline/gumcad-sti-surveillance-system-chrome-1200x900-dpr-1.png differ diff --git a/baseline/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png b/baseline/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png index 3bdf600..b833c17 100644 Binary files a/baseline/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png and b/baseline/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png differ diff --git a/baseline/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png b/baseline/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png index e001cd5..4306203 100644 Binary files a/baseline/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png and b/baseline/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png differ diff --git a/baseline/healthy-child-record-chrome-1200x900-dpr-1.png b/baseline/healthy-child-record-chrome-1200x900-dpr-1.png index 4ab364e..3ac63cf 100644 Binary files a/baseline/healthy-child-record-chrome-1200x900-dpr-1.png and b/baseline/healthy-child-record-chrome-1200x900-dpr-1.png differ diff --git a/baseline/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png b/baseline/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png index eb9c2fd..f7c4c57 100644 Binary files a/baseline/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png and b/baseline/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png differ diff --git a/baseline/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png b/baseline/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png index 851427f..55b69bf 100644 Binary files a/baseline/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png and b/baseline/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png differ diff --git a/baseline/improving-access-to-psychological-therapies-data-set-chrome-1200x900-dpr-1.png b/baseline/improving-access-to-psychological-therapies-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..3206bbc Binary files /dev/null and b/baseline/improving-access-to-psychological-therapies-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png b/baseline/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png index 4b4f420..e846edb 100644 Binary files a/baseline/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png and b/baseline/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png differ diff --git a/baseline/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png b/baseline/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png index 8e17733..768c69d 100644 Binary files a/baseline/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png and b/baseline/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png differ diff --git a/baseline/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png b/baseline/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png index 5b18c15..472babb 100644 Binary files a/baseline/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png and b/baseline/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png differ diff --git a/baseline/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png b/baseline/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png index 84def1e..2068aaf 100644 Binary files a/baseline/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png and b/baseline/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png differ diff --git a/baseline/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png b/baseline/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png index c3ea29c..d12f091 100644 Binary files a/baseline/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png and b/baseline/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png b/baseline/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png index 63e88c7..43ff8f3 100644 Binary files a/baseline/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png and b/baseline/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/maternity-services-data-set-chrome-1200x900-dpr-1.png b/baseline/maternity-services-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..fe46db1 Binary files /dev/null and b/baseline/maternity-services-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png b/baseline/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png index 885b666..6db5789 100644 Binary files a/baseline/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png and b/baseline/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png differ diff --git a/baseline/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png b/baseline/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png index d872597..477779b 100644 Binary files a/baseline/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png and b/baseline/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png differ diff --git a/baseline/mental-health-services-data-set-chrome-1200x900-dpr-1.png b/baseline/mental-health-services-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..a121c57 Binary files /dev/null and b/baseline/mental-health-services-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/national-drug-and-alcohol-treatment-monitoring-system-ndtms-data-set-chrome-1200x900-dpr-1.png b/baseline/national-drug-and-alcohol-treatment-monitoring-system-ndtms-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..ac90eaf Binary files /dev/null and b/baseline/national-drug-and-alcohol-treatment-monitoring-system-ndtms-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png b/baseline/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png index 90e2ce7..b7b55b5 100644 Binary files a/baseline/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png and b/baseline/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png b/baseline/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png index 8d1f625..bf63858 100644 Binary files a/baseline/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png and b/baseline/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/national-joint-registry-data-set-chrome-1200x900-dpr-1.png b/baseline/national-joint-registry-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..8f98451 Binary files /dev/null and b/baseline/national-joint-registry-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png b/baseline/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png index 81f3a2f..2d324b7 100644 Binary files a/baseline/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/national-workforce-data-set-chrome-1200x900-dpr-1.png b/baseline/national-workforce-data-set-chrome-1200x900-dpr-1.png index ae44098..c0e5e88 100644 Binary files a/baseline/national-workforce-data-set-chrome-1200x900-dpr-1.png and b/baseline/national-workforce-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/neonatal-critical-care-minimum-data-set-chrome-1200x900-dpr-1.png b/baseline/neonatal-critical-care-minimum-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..60c0a16 Binary files /dev/null and b/baseline/neonatal-critical-care-minimum-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/neonatal-data-set-chrome-1200x900-dpr-1.png b/baseline/neonatal-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..da00d77 Binary files /dev/null and b/baseline/neonatal-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/nhs-111-api-standard-chrome-1200x900-dpr-1.png b/baseline/nhs-111-api-standard-chrome-1200x900-dpr-1.png index 145708b..5e0d584 100644 Binary files a/baseline/nhs-111-api-standard-chrome-1200x900-dpr-1.png and b/baseline/nhs-111-api-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png b/baseline/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png index 926ce10..606ed8b 100644 Binary files a/baseline/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/nhs-continuing-healthcare-chc-patient-level-data-set-chrome-1200x900-dpr-1.png b/baseline/nhs-continuing-healthcare-chc-patient-level-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..cdb244c Binary files /dev/null and b/baseline/nhs-continuing-healthcare-chc-patient-level-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/nhs-number-chrome-1200x900-dpr-1.png b/baseline/nhs-number-chrome-1200x900-dpr-1.png index c97bd6a..c32b4de 100644 Binary files a/baseline/nhs-number-chrome-1200x900-dpr-1.png and b/baseline/nhs-number-chrome-1200x900-dpr-1.png differ diff --git a/baseline/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png b/baseline/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png index c97bd6a..c32b4de 100644 Binary files a/baseline/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png and b/baseline/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png differ diff --git a/baseline/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png b/baseline/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png index c97bd6a..c32b4de 100644 Binary files a/baseline/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png and b/baseline/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png differ diff --git a/baseline/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png b/baseline/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png index 1f80bee..0633b9b 100644 Binary files a/baseline/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png and b/baseline/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png differ diff --git a/baseline/outpatient-letter-chrome-1200x900-dpr-1.png b/baseline/outpatient-letter-chrome-1200x900-dpr-1.png index 5de4863..5740d32 100644 Binary files a/baseline/outpatient-letter-chrome-1200x900-dpr-1.png and b/baseline/outpatient-letter-chrome-1200x900-dpr-1.png differ diff --git a/baseline/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png b/baseline/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png index ed50907..66efd3e 100644 Binary files a/baseline/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png and b/baseline/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png differ diff --git a/baseline/paediatric-critical-care-minimum-data-set-chrome-1200x900-dpr-1.png b/baseline/paediatric-critical-care-minimum-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..14062d0 Binary files /dev/null and b/baseline/paediatric-critical-care-minimum-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png b/baseline/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png index 0ed2776..7dd19a3 100644 Binary files a/baseline/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png and b/baseline/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png differ diff --git a/baseline/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png b/baseline/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png index c72166d..11ca04a 100644 Binary files a/baseline/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png and b/baseline/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png b/baseline/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png index 7ad45c3..c1acd60 100644 Binary files a/baseline/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png b/baseline/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png index 370e036..4664098 100644 Binary files a/baseline/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png and b/baseline/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png b/baseline/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png index 04d6f40..dc710f0 100644 Binary files a/baseline/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png and b/baseline/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png b/baseline/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png index 30958ff..ba38d10 100644 Binary files a/baseline/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png and b/baseline/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png differ diff --git a/baseline/patient-level-contract-monitoring-chrome-1200x900-dpr-1.png b/baseline/patient-level-contract-monitoring-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..cb175c7 Binary files /dev/null and b/baseline/patient-level-contract-monitoring-chrome-1200x900-dpr-1.png differ diff --git a/baseline/patient-level-information-and-costing-systems-ambulance-data-set-chrome-1200x900-dpr-1.png b/baseline/patient-level-information-and-costing-systems-ambulance-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..e9f095c Binary files /dev/null and b/baseline/patient-level-information-and-costing-systems-ambulance-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/patient-level-information-and-costing-systems-integrated-data-set-chrome-1200x900-dpr-1.png b/baseline/patient-level-information-and-costing-systems-integrated-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..e9f095c Binary files /dev/null and b/baseline/patient-level-information-and-costing-systems-integrated-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png b/baseline/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png index a7ed953..f23bf80 100644 Binary files a/baseline/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/personal-demographics-service-smsp-api-standards-chrome-1200x900-dpr-1.png b/baseline/personal-demographics-service-smsp-api-standards-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..4ae3666 Binary files /dev/null and b/baseline/personal-demographics-service-smsp-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png b/baseline/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png index 788c7af..2a6d351 100644 Binary files a/baseline/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png and b/baseline/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png differ diff --git a/baseline/radiotherapy-data-set-chrome-1200x900-dpr-1.png b/baseline/radiotherapy-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..fc197b3 Binary files /dev/null and b/baseline/radiotherapy-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/secure-email-chrome-1200x900-dpr-1.png b/baseline/secure-email-chrome-1200x900-dpr-1.png index 0a31be3..1f65ddd 100644 Binary files a/baseline/secure-email-chrome-1200x900-dpr-1.png and b/baseline/secure-email-chrome-1200x900-dpr-1.png differ diff --git a/baseline/sexual-and-reproductive-health-activity-dataset-chrome-1200x900-dpr-1.png b/baseline/sexual-and-reproductive-health-activity-dataset-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..5b6cd39 Binary files /dev/null and b/baseline/sexual-and-reproductive-health-activity-dataset-chrome-1200x900-dpr-1.png differ diff --git a/baseline/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png b/baseline/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png index 2a4c83e..a045183 100644 Binary files a/baseline/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png and b/baseline/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png differ diff --git a/baseline/shared-decision-making-chrome-1200x900-dpr-1.png b/baseline/shared-decision-making-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..cd0f7b2 Binary files /dev/null and b/baseline/shared-decision-making-chrome-1200x900-dpr-1.png differ diff --git a/baseline/snomed-ct-chrome-1200x900-dpr-1.png b/baseline/snomed-ct-chrome-1200x900-dpr-1.png index cdcd34f..0c8f30f 100644 Binary files a/baseline/snomed-ct-chrome-1200x900-dpr-1.png and b/baseline/snomed-ct-chrome-1200x900-dpr-1.png differ diff --git a/baseline/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png b/baseline/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png index d413108..b35b21c 100644 Binary files a/baseline/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png and b/baseline/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/baseline/surgical-devices-and-implants-core-data-set-chrome-1200x900-dpr-1.png b/baseline/surgical-devices-and-implants-core-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..6ce24c9 Binary files /dev/null and b/baseline/surgical-devices-and-implants-core-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/surveillance-of-healthcare-associated-infections-chrome-1200x900-dpr-1.png b/baseline/surveillance-of-healthcare-associated-infections-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..2b2d11d Binary files /dev/null and b/baseline/surveillance-of-healthcare-associated-infections-chrome-1200x900-dpr-1.png differ diff --git a/baseline/systemic-anti-cancer-therapy-data-set-chrome-1200x900-dpr-1.png b/baseline/systemic-anti-cancer-therapy-data-set-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..6d388fc Binary files /dev/null and b/baseline/systemic-anti-cancer-therapy-data-set-chrome-1200x900-dpr-1.png differ diff --git a/baseline/transfer-of-care-acute-inpatient-discharge-standard-chrome-1200x900-dpr-1.png b/baseline/transfer-of-care-acute-inpatient-discharge-standard-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..cca5e6a Binary files /dev/null and b/baseline/transfer-of-care-acute-inpatient-discharge-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png b/baseline/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png index 7a99bf9..364ed7f 100644 Binary files a/baseline/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png b/baseline/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png index bae03d7..ced9238 100644 Binary files a/baseline/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png b/baseline/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png index e69660e..e3f7bf2 100644 Binary files a/baseline/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png b/baseline/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png index a4ade46..f820157 100644 Binary files a/baseline/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png b/baseline/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png index 68f612e..4151d41 100644 Binary files a/baseline/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png and b/baseline/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png differ diff --git a/baseline/uk-core-fast-healthcare-interoperability-resources-fhir-release-4-r4-governance-chrome-1200x900-dpr-1.png b/baseline/uk-core-fast-healthcare-interoperability-resources-fhir-release-4-r4-governance-chrome-1200x900-dpr-1.png new file mode 100644 index 0000000..03ce956 Binary files /dev/null and b/baseline/uk-core-fast-healthcare-interoperability-resources-fhir-release-4-r4-governance-chrome-1200x900-dpr-1.png differ diff --git a/baseline/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png b/baseline/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png index 02ad874..ca6c4e5 100644 Binary files a/baseline/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png and b/baseline/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png differ diff --git a/baseline/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png b/baseline/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png index 75671a5..7fd6e0e 100644 Binary files a/baseline/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png and b/baseline/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png differ diff --git a/baseline/vaccination-apis-chrome-1200x900-dpr-1.png b/baseline/vaccination-apis-chrome-1200x900-dpr-1.png index d721f2c..f6e3384 100644 Binary files a/baseline/vaccination-apis-chrome-1200x900-dpr-1.png and b/baseline/vaccination-apis-chrome-1200x900-dpr-1.png differ diff --git a/baseline/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png b/baseline/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png index 74fcc4e..070eb29 100644 Binary files a/baseline/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png and b/baseline/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/baselineTexts/about-me.txt b/baselineTexts/about-me.txt index f19af44..959c512 100644 --- a/baselineTexts/about-me.txt +++ b/baselineTexts/about-me.txt @@ -14,6 +14,8 @@ Endorsement This standard has been endorsed by the following organisations; +Association for Real Change +Associated Retirement Community Operators British Association for Music Therapy British Dietetic Association British Geriatrics Society @@ -25,12 +27,16 @@ Compassion in Dying Health and Social Care Alliance Scotland Institute of Health Records and Information Management Local Government Association +National Data Guardian +Patient Information Forum Resuscitation Council UK Royal College of Emergency Medicine Royal College of General Practitioners Royal College of Nursing Royal College of Occupational Therapists Royal College of Physicians +Royal College of Psychiatrists +Royal College of Radiologists Royal Pharmaceutical Society   Why is ‘About Me’ so important? @@ -39,6 +45,8 @@ Clinical Informatics Lead of the Social Care Programme at NHS Digital, Keith Str +  + About me standard v1.2 Supporting documents diff --git a/baselineTexts/accessible-information.txt b/baselineTexts/accessible-information.txt index 092540b..ba2505d 100644 --- a/baselineTexts/accessible-information.txt +++ b/baselineTexts/accessible-information.txt @@ -27,7 +27,7 @@ Stage Implementation Key documents Specification (Amd 27/2017) Specification - Change Paper (Amd 27/2017) -Implementation Guidance (Amd 27/2017) +Implementation Guidance (Amd 27/2017) [Archive Content] Implementation Guidance - Change Paper (Amd 27/2017) Information Standards Notice (Amd 27/2017) @@ -41,8 +41,8 @@ Release number Amd 8/2013 Release title Initial Standard Stage Retirement Key documents -Specification (Amd 8/2013) -Implementation Guidance (Amd 8/2013) +Specification (Amd 8/2013) [Archive Content] +Implementation Guidance (Amd 8/2013) [Archive Content] Information Standards Notice (Amd 8/2013) Supporting documents @@ -50,4 +50,4 @@ NHS Data Model and Dictionary Change Request 1475 (Amd 8/2013) Further information Accessible Information web pages -Last edited: 1 November 2018 3:18 pm \ No newline at end of file +Last edited: 12 July 2022 10:19 am \ No newline at end of file diff --git a/baselineTexts/aggregate-contract-monitoring.txt b/baselineTexts/aggregate-contract-monitoring.txt new file mode 100644 index 0000000..cbdf1fe --- /dev/null +++ b/baselineTexts/aggregate-contract-monitoring.txt @@ -0,0 +1,152 @@ +Contract Monitoring + +A set of four information standards for Contract Monitoring to enable national consistency of the flow of cost and activity information from providers to commissioners. + +Page contents +Top of page +About this information standard +Current releases +Previous releases +Updates +About this information standard + +The Contract Monitoring information standards are a set of standards being introduced by NHS England and NHS Improvement to enable national consistency of the flow of cost and activity information from providers to commissioners. The standards are: + +DCB2050 Aggregate Contract Monitoring  +DCB3003 Patient Level Contract Monitoring +DCB3002 Devices Patient Level Contract Monitoring +DCB2212 Drugs Patient Level Contract Monitoring. + +Having national standards to support contract monitoring will: + +reduce burden +allow simpler and more consistent reporting +allow easier reconciliation and validation of invoices +provide support for service change planning and hospital capacity analysis +improve forecasting +allow greater monitoring of equity of access to services. + +These information standards are published under section 250 of the Health and Social Care Act 2012.  An Information Standards Notice for each standard (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standards. Note that while the NHS Data Model and Dictionary documents are listed under each standard, they are consolidation documents encompassing all four standards. + +Additional guidance documentation is available on the NHS England website: https://www.england.nhs.uk/nhs-standard-contract/dc-reporting + +In the event of issues or questions about any of these standards, please contact the developers at NHS England and NHS Improvement: england.nccis@nhs.net. + +Future development of the standards + +The contract monitoring standards became national data standards in April 2021 and had an implementation date of September 2021 for reporting of activity in October 2021. + +Given the mid-year implementation date, it has been decided that there will be no alterations to these standards during 2021-22 or 2022-23 in order for reporting systems to bed-in and become mature. + +Consideration of suggested changes and/or developments to the four standards will start in 2022-23. Users may submit suggestions from April 2022 to england.nccis@nhs.net  + +Suggestions will be considered by a multi-disciplinary working party comprising representation from suitable relevant stakeholders during September-October 2022. Those suggested changes considered by the group to be essential or of merit will then go out to national consultation in December 2022 as required for all suggested changes to national data standards. + +Current releases +DCB2050 Aggregate Contract Monitoring (ACM) Version 2.0 +Release date 08/04/2021 +Release number Amd 73/2020 +Key documents +Change Specification (Amd 73/2020) +Requirements Specification (Amd 73/2020) +Implementation Guidance (Amd 73/2020) +Information Standards Notice (Amd 73/2020) + +Supporting documents +Technical Details Specification v2.1 (Amd 73/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 73/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 73/2020) +User Guidance v1.3 (Amd 73/2020) +DCB3003 Patient Level Contract Monitoring (PLCM) Version 2.0 +Release date  08/04/2021 +Release number Amd 76/2020 +Key documents  +Change Specification (Amd 76/2020) +Requirements Specification (Amd 76/2020) +Implementation Guidance (Amd 76/2020) +Information Standards Notice (Amd 76/2020) + +Supporting documents +Technical Details Specification v2.1 (Amd 76/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 76/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 76/2020)  +User Guidance v1.2 (Amd 76/2020) +DCB3002 Devices Patient Level Contract Monitoring (DePLCM) Version 2.0 +Release date 08/04/2021 +Release number Amd 75/2020 +Key documents +Change Specification (Amd 75/2020) +Requirements Specification (Amd 75/2020) +Implementation Guidance (Amd 75/2020) +Information Standards Notice (Amd 75/2020)  + +Supporting documents +Technical Details Specification v2.2 (Amd 75/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 75/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 75/2020)  +User Guidance v1.1 (Amd 75/2020) +DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM) Version 2.0 +Release date 08/04/2021 +Release number Amd 74/2020 +Key documents +Change Specification (Amd 74/2020) +Requirements Specification (Amd 74/2020) +Implementation Guidance (Amd 74/2020) +Information Standards Notice (Amd 74/2020) + +Supporting documents +Technical Details Specification v2.6 (Amd 74/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 74/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 74/2020) +User Guidance v1.2 (Amd 74/2020)  +Previous releases + +Documents for earlier releases of the Contract Monitoring information standards can be viewed on our Contract Monitoring archive page. + +Updates + +11 October 2022: Minor changes have been made to the user guidance for clarification, for contract monitoring standards DCB2050 Aggregate Contract Monitoring (ACM) (see section 7 and section 8 (FAQs) Q16) and DCB3003 Patient Level Contract Monitoring (PLCM) (see section 8 (FAQs) Q8).  + +There has also been a minor change made to the Technical Details Specification document for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy reference table, which now matches the latest (v17.2) list of medicines not reimbursed through national prices that are directly commissioned by NHS England. + +  + +8 July 2022: A minor change has been made to the Technical Details Specification document for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy reference table, which now matches the latest (v17.1) list of medicines not reimbursed through national prices that are directly commissioned by NHS England. + +  + +12 May 2022: A minor change has been made to the Technical Details Specification documents for each of the contract monitoring standards (DCB2050 Aggregate Contract Monitoring (ACM), DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM), DCB3002 Devices Patient Level Contract Monitoring (DePLCM) and DCB3003 Patient Level Contract Monitoring (PLCM)). This update relates to the addition of a new code (code 32) in the Commissioned Service Category Code reference table of each document, to accommodate the forthcoming introduction of the NHS England Innovative Medicines Fund. + +There has also been a further change to the Technical Details Specification document for DCB3002 Devices Patient Level Contract Monitoring (DePLCM), with an update to the device taxonomy reference table. This change has been made as in the final 2022/23 tariff guidance the Stent Retriever (DEV54) category was combined into the Mechanical Thrombectomy category (DEV51) and as such the code DEV54 for Stent Retriever is not required separately. The Mechanical Thrombectomy category (DEV51) has been renamed as “Mechanical Thrombectomy Stent Retrievers and Clot Retrievers” as per the National Tariff Guidance. + +  + +21 April 2022: Minor changes have been made to the Technical Details Specification documents for each of the contract monitoring standards (DCB2050 Aggregate Contract Monitoring (ACM), DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM), DCB3002 Devices Patient Level Contract Monitoring (DePLCM) and DCB3003 Patient Level Contract Monitoring (PLCM)). These updates relate to the addition of a new code (code 12) in the Commissioned Service Category Code reference table of each document, to accommodate the forthcoming introduction of Integrated Care Boards (ICBs), following approval of the legislation. + +There have also been several new ‘High Level Codes’ added to the Taxonomy reference table in the DCB3002 DePLCM Technical Details Specification. + +  + +2 March 2022: A minor change has been made to the Technical Details Specification documents for both DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM) and DCB3002 Devices Patient Level Contract Monitoring (DePLCM). This update relates to the the 'Point of Delivery Code' tab in each document.  + +  + +2 February 2022: A minor change has been made to the Technical Details Specification for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy list to reflect the 2021-22 list (v16.1) of drugs not reimbursed through national prices and directly commissioned by NHS England. + +  + +16 November 2021: Copies of the User Guidance for each of the four standards, originally published on the NHS England and NHS Improvement website, have been added to the 'Supporting documents' sections above.  + +  + +8 July 2021: A minor change has been made to the Technical Details Specification for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy list to finally reflect the 2021-22 list (v16) of high cost drugs that are outside the National Tariff. + +  + +30 June 2021: A minor change has been made to the Technical Details Specification for DCB3002 Devices Patient Level Contract Monitoring (DePLCM), in relation to the taxonomy supporting reference table within the workbook.   + +  + +28 April 2021: Links to the NHS Data Model and Dictionary have been updated in the specification and technical specification documents above, following a recent change in platform. + +Last edited: 11 October 2022 5:56 pm \ No newline at end of file diff --git a/baselineTexts/ambulance-handover-to-emergency-care.txt b/baselineTexts/ambulance-handover-to-emergency-care.txt index 88cbe6a..2da762f 100644 --- a/baselineTexts/ambulance-handover-to-emergency-care.txt +++ b/baselineTexts/ambulance-handover-to-emergency-care.txt @@ -1,6 +1,14 @@ -Ambulance Handover to Emergency Care Standard V1.0 -Emergency care needs fast, effective sharing of information. When clinicians have access to the information they need, they can better ensure safe and high-quality care for patients. To facilitate this, The Professional Record Standards Body (PRSB) has developed a standard for the information that is shared when care is transferred from ambulances to emergency departments. Once implemented, the standard for handover will improve continuity of care, as emergency care will have the information they need available to them on a timely basis. Whichever ambulance service brings the patient to the hospital, there will be a consistent set of information available to the emergency department. It means that patient safety will be improved, because emergency care professionals will know what medications have been administered, what diagnostic tests have been done, whether the patient has any allergies and other important information. Sharing clinical information with emergency care will also support professionals in arranging patient discharge and preventing unnecessary admissions. The PRSB have collaborated with the Royal College of Physicians Health Informatics Unit on this project. Clinical leadership was provided by clinicians from the Royal College of Emergency Medicine and the College of Paramedics (CoP). The standard has been developed with the support of professionals and patients. The standard is published as a draft while we seek endorsement from relevant members and other organisations. -Endorsed by: +Ambulance handover to emergency care standard V1.0 + +Emergency care needs fast, effective sharing of information. When clinicians have access to the information they need, they can better ensure safe and high-quality care for patients. To facilitate this, The Professional Record Standards Body (PRSB) has developed a standard for the information that is shared when care is transferred from ambulances to emergency departments. + +Once implemented, the standard for handover will improve continuity of care, as emergency care will have the information they need available to them on a timely basis. Whichever ambulance service brings the patient to the hospital, there will be a consistent set of information available to the emergency department. It means that patient safety will be improved, because emergency care professionals will know what medications have been administered, what diagnostic tests have been done, whether the patient has any allergies and other important information. Sharing clinical information with emergency care will also support professionals in arranging patient discharge and preventing unnecessary admissions. + +The PRSB have collaborated with the Royal College of Physicians Health Informatics Unit on this project. Clinical leadership was provided by clinicians from the Royal College of Emergency Medicine and the College of Paramedics (CoP). The standard has been developed with the support of professionals and patients. + +  + +This standard is endorsed by: Association of Ambulance Chief Executives Chartered Society of Physiotherapists College of Paramedics diff --git a/baselineTexts/anonymisation-standard-for-publishing-health-and-social-care-data.txt b/baselineTexts/anonymisation-standard-for-publishing-health-and-social-care-data.txt index 5186b40..3baa36e 100644 --- a/baselineTexts/anonymisation-standard-for-publishing-health-and-social-care-data.txt +++ b/baselineTexts/anonymisation-standard-for-publishing-health-and-social-care-data.txt @@ -30,7 +30,7 @@ Key documents Specification (Amd 20/2010) Supporting documents -Guidance (Amd 20/2010) +Guidance (Amd 20/2010) [Archive Content] Information Standards Notice (Amd 20/2010) Planning Record (Amd 20/2010) diff --git a/baselineTexts/assessment-discharge-and-withdrawal-fhir-api.txt b/baselineTexts/assessment-discharge-and-withdrawal-fhir-api.txt index 4f74ce1..6c0f9c9 100644 --- a/baselineTexts/assessment-discharge-and-withdrawal-fhir-api.txt +++ b/baselineTexts/assessment-discharge-and-withdrawal-fhir-api.txt @@ -1,13 +1,13 @@ -Assessment Discharge and Withdrawal - FHIR API +Assessment Discharge and Withdrawal - FHIR Support transfer of care from hospital to social services for patients with care and support needs. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -17,11 +17,22 @@ Onboarding Interactions Additional guidance -This specification is under review following changes to discharge process guidance during 2020 to reflect Discharge to Assess (D2A). Contact enquires@nhsdigital.nhs.uk if you have any questions. +This integration is deprecated, but we do not have any plans to retire it. + +For more details, see the status. Overview +Hospital system +MESH +Social services +send admission, assessment, discharge and withdrawal notices  +receive admission, +assessment, discharge + and withdrawal notices + +  -Use this API to support transfer of care from hospital to social services for patients with care and support needs, as described in the Care Act 2014. It enables the exchange of structured information between hospitals and social care organisations. +Use this integration to support transfer of care from hospital to social services for patients with care and support needs, as described in the Care Act 2014. It enables the exchange of structured information between hospitals and social care organisations. You can send: @@ -29,44 +40,53 @@ hospital assessment notices to inform social services that an assessment of a p hospital discharge notices to confirm a patient's proposed discharge date withdrawal notices to withdraw a previous assessment or discharge notice -You can also send an admissions notice with this API so a hospital can inform social services that a patient has been admitted. +You can also send an admissions notice with this integration so a hospital can inform social services that a patient has been admitted. -Information Standard SCCI2075 defines the minimum data sets that you must use for Assessment, Discharge and Withdrawal (ADW) notices. There is also additional message guidance on the implementation and use of ADW FHIR messages and some divergences from this ADW Information Standard. +This is a messaging integration which uses MESH to send and receive messages. -For more details see Assessment Discharge and Withdrawal - FHIR API. +Information Standard SCCI2075 defines the minimum data sets that you must use for Assessment, Discharge and Withdrawal (ADW) notices. For additional message guidance on the implementation and use of ADW FHIR messages and some divergences from this ADW Information Standard, see Assessment Discharge and Withdrawal - FHIR API. -Before you begin any development work using this API, contact us to discuss your best options. +This integration is deprecated. Do not begin any development work using this API. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.  +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.  You must have made this request before you can go live (see 'Onboarding' below). Related APIs -The following APIs are related to this one: +The following API is related to this integration: Message Exchange for Social Care and Health (MESH) API - use this API to transfer messages and large files securely across health and social care organisations -API status +Status + +This integration is deprecated, meaning: -This API is in beta. +new integrations are not allowed +we will not make any updates to it +it is still available for use +service levels still apply + +We do not have any plans to retire it. + +This specification is deprecated following changes to the discharge process guidance during 2020 to reflect Discharge to Assess (D2A). If you have any concerns, contact enquires@nhsdigital.nhs.uk. Service level -This API uses MESH which is a silver service, meaning it is operational  24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational  24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. Specifically, it sends a DSTU2 payload over MESH. +This integration sends a FHIR DSTU2 payload over MESH. For more details, see FHIR. Network access -You can access this API via: +You can access this integration via: the Health and Social Care Network (HSCN) the internet @@ -75,17 +95,17 @@ For more details, see Network access for APIs. Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -The API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +This integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. Environments and testing -This API uses MESH. +This integration uses MESH. -We have developed an ADW-MESH validator to help you check your messages are valid when sending ADW messages over the MESH transport. +We have developed an Interoperability Toolkit (ITK) ADW-MESH validator to help you check that your messages are valid according to ITK FHIR schemas and requirements before they are set over MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. @@ -95,18 +115,29 @@ For the MESH API, there are several independent, externally accessible instances Onboarding -You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. - -To onboard for this API, follow the Supplier Conformance Assessment List (SCAL) process. +This integration is deprecated and is not available for new onboarding. Interactions -For a full list of interactions for this API, see Social Care Assessment, Discharge and Withdrawal. +For a full list of interactions for this integration, see Social Care Assessment, Discharge and Withdrawal. This FHIR messaging specification is based on and is intended to be used alongside the FHIR DSTU2 specification, published in September 2015. +The following MESH workflow IDs are used to send the admission, assessment, discharge and withdrawal notifications in England: + +Scenario From To MESH Workflow ID +Send admission notice  Hospital systems Social care service systems SOCCARE_ADMISSN_NTC +Send assessment notice Hospital systems Social care service systems SOCCARE_ASSESS_NTC +Send assessment notice accepted response  Social care service systems Hospital systems SOCCARE_ASSESS_NTC__ACPT +Send assessment notice rejected response Social care service systems Hospital systems SOCCARE_ASSESS_NTC_RJT +Send discharge notice Hospital systems Social care service systems SOCCARE_DISCH_NTC +Send discharge notice accepted response Social care service systems Hospital systems SOCCARE_DISCH_NTC_ACPT +Send assessment notice rejected response Social care service systems Hospital systems SOCCARE_DISCH_NTC_RJT +Send withdrawal notice Hospital systems Social care service systems SOCCARE_WDRAW_NTC +Send withdrawal notice accepted response Social care service systems Hospital systems SOCCARE_WDRAW_NTC_ACPT +Send withdrawal notice rejected response Social care service systems Hospital systems SOCCARE_WDRAW__NTC_RJT Additional guidance -For additional guidance on interactions for this API, see the Social care DMS - additional messaging guidance. +For additional guidance on interactions for this integration, see the Social care DMS - additional messaging guidance. -Last edited: 26 May 2022 3:10 pm \ No newline at end of file +Last edited: 12 October 2022 6:18 pm \ No newline at end of file diff --git a/baselineTexts/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services.txt b/baselineTexts/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services.txt index 7df06dc..c7d487b 100644 --- a/baselineTexts/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services.txt +++ b/baselineTexts/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services.txt @@ -1,53 +1,51 @@ SCCI2075: Assessment, Discharge and Withdrawal Notices between Hospitals and Social Services -This information standard defines a set of Assessment, Discharge and Withdrawal (ADW) Notices to support compliance with the Care Act 2014. +This information standard defined a set of Assessment, Discharge and Withdrawal (ADW) Notices to support compliance with the Care Act 2014. Page contents Top of page About this information standard Current release Initial release +Updates +About this information standard -This standard will not be updated and there will be no further development on this product. - -It should be noted that the product does not support the Discharge to Assess process. - -Any development to this standard will be at the supplier’s risk as it doesn’t support government policy.  +This information standard defined a set of Assessment, Discharge and Withdrawal (ADW) Notices to support compliance with the Care Act 2014. These Notices were used to support the discharge of hospital patients considered to have social care needs, and the information standard defined the minimum set of data items to be used for these Notices. -For any questions, please contact enquries@nhsdigital.nhs.uk. +Following engagement with NHS England, Local Authorities, the Professional Record Standards Body (PRSB), suppliers and users, the NHS Digital developers of SCCI2075 agreed that no further development of the standard would occur, and that it would no longer be supported, as the product does not support current national government or NHS discharge policy, including Discharge to Assess (D2A). -About this information standard +The retirement of this information standard was formally approved by the Data Alliance Partnership Board (DAPB) in June 2022, and an Information Standards Notice (ISN) confirming the retirement was issued.  -This information standard defines a set of Assessment, Discharge and Withdrawal (ADW) Notices to support compliance with the Care Act 2014. These Notices are to be used to support the discharge of hospital patients that are considered to have social care needs. +The documents on this page relating to the standard are now provided for reference only.  -The initial standard was published in June 2016. An updated release (Amd 70/2016, November 2016) introduces changes to, and corrections of, a number of data items and notes the removal of technical implementation options from the standard documents. Full details of the changes can be found in the Information Standards Notice (see below). - -This information standard is published under section 250 of the Health and Social Care Act 2012. The Information Standards Notice provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. +  Current release Release date 02/11/2016 Release number Amd 70/2016 Release title Version 2.0 -Stage Implementation +Stage Retired Key documents -Requirements Specification (Amd 70/2016) +Requirements Specification (Amd 70/2016) [Archive Content] Implementation Guidance (Amd 70/2016) Information Standards Notice (Amd 70/2016) +Information Standards Notice (retirement of standard) Further information -Technical guidance is available on the - - NHS Health Developer Network + NHS Digital ADW specification guidance  Initial release Release date 22/06/2016 Release number Amd 29/2015 Release title Initial Standard -Stage Implementation +Stage Superseded by Amd 70/2016 Key documents -Requirements Specification (Amd 29/2015) +Requirements Specification (Amd 29/2015) [Archive Content] Implementation Guidance (Amd 29/2015) Information Standards Notice (Amd 29/2015) +Updates + +21 July 2022: Publication of Information Standards Notice announcing retirement of the standard.  -Last edited: 12 January 2022 11:47 am \ No newline at end of file +Last edited: 5 August 2022 1:57 pm \ No newline at end of file diff --git a/baselineTexts/assuring-transformation.txt b/baselineTexts/assuring-transformation.txt new file mode 100644 index 0000000..ae6be36 --- /dev/null +++ b/baselineTexts/assuring-transformation.txt @@ -0,0 +1,60 @@ +DCB2007: Assuring Transformation + +This data collection informs NHS England's monitoring of the progress in moving people with learning disabilities from inpatient to community settings. + +Page contents +Top of page +About this information standard +Current release +Previous releases +About this information standard + +Assuring Transformation is an information standard incorporating a mandatory data collection that has been developed in response to Transforming Care: A national response to Winterbourne View Hospital and Winterbourne View Review: Concordat: A Programme of Action. + +This data collection supports NHS England and NHS Improvement's monitoring of the progress in moving people with learning disabilities from inpatient to community settings. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +  + +Update 30 March 2021: + +The latest release of this standard (DCB2007 Amd 35/2020) was published on 23 December 2020.  Following publication, several minor typographical errors were identified in the Data Set Specification. An updated Data Set Specification (Version 1.1 dated March 2021) has been published to correct these minor issues, and is available below. Note that there is no impact on the published Requirements Specification, Implementation Guidance or Change Specification. + +If you have any questions about this update, or other Assuring Transformation issues, you can contact the developers by emailing: enquiries@nhsdigital.nhs.uk (quote Assuring Transformation in the subject line).  + +  + +Current release +Release date 23/12/2020 +Release number Amd 35/2020 +Release title Version 3.0 +Stage Implementation +Key documents +Information Standards Notice (Amd 35/2020) +Requirements Specification (Amd 35/2020) [Archive Content] +Implementation Guidance (Amd 35/2020) +Change Specification (Amd 35/2020) +Data Set Specification v1.1 (Amd 35/2020) (March 2021) + +Further information Further information, and additional user guidance, is available on the NHS Digital website. +Previous releases +Release date 09/11/2015 +Release number Amd 37/2015 +Release title Version 2.0 +Stage Maintenance +Key documents +Requirements Specification (Amd 37/2015) [Archive Content] +Implementation Guidance (Amd 37/2015) +Change Specification (Amd 37/2015) +Information Standards Notice (Amd 37/2015) +Release date 06/01/2015 +Release number Amd 7/2014 +Release title Initial Collection +Stage Retirement +Key documents +Requirements Specification (Amd 7/2014) [Archive Content] +Implementation Guidance (Amd 7/2014) +Information Standards Notice (Amd 7/2014) + +Last edited: 30 March 2021 3:56 pm \ No newline at end of file diff --git a/baselineTexts/bowel-cancer-screening-edifact-api.txt b/baselineTexts/bowel-cancer-screening-edifact-api.txt index 86f928f..30569aa 100644 --- a/baselineTexts/bowel-cancer-screening-edifact-api.txt +++ b/baselineTexts/bowel-cancer-screening-edifact-api.txt @@ -1,13 +1,13 @@ -Bowel Cancer Screening - EDIFACT API +Bowel Cancer Screening - EDIFACT Receive bowel cancer screening test results in GP practices from the screening system. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -17,10 +17,17 @@ Onboarding Interactions Additional guidance Overview +send test results +Cancer screening system +MESH +GP system +receive test results -Use this API to receive bowel cancer screening test results in GP practices from the screening system, specifically faecal occult blood test (FOBT) results. +  + +Use this messaging integration to receive bowel cancer screening test results in primary care GP systems from the screening system, specifically faecal occult blood test (FOBT) results. -It's designed for the transmission of structured bowel cancer screening results to primary care GP systems from the screening system, using UN/EDIFACT based messages sent over MESH. +This integration uses UN/EDIFACT based messages sent over MESH. Also known as NHS004 messages, these are a simpler version of the NHS003 messages specified in the Pathology EDIFACT v1.003 Standard but with the changes specified in 'Electronic GP Communication Requirements for GPSoC Software Suppliers Draft', under 'Additional guidance' below. @@ -28,32 +35,36 @@ Bowel cancer screening NHS004 messages are almost the same as pathology NHS003 m If you are building a system to receive bowel cancer screening test results, you can use our Lab Results adaptor to receive these EDIFACT results via an easy-to-use FHIR-compliant format.  -Before you begin any development work using this API, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. +This integration  can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below). Related APIs -The following screening APIs are related to this one: +The following API is related to this integration: + +Message Exchange for Social Care and Health (MESH) API - use this API to transfer messages and large files securely across health and social care organisations + +The following screening integration is related to this one: -Pathology Messaging - EDIFACT API - use this to receive pathology test results in GP practices from laboratories using EDIFACT messages sent over MESH -API status +Pathology Messaging - EDIFACT - use this to receive pathology test results in GP practices from laboratories using EDIFACT messages sent over MESH +Status -This API is stable. +This integration is in production. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This is an asynchronous messaging API. Messages are: +This is an asynchronous messaging integration. Messages are: formatted as EDIFACT sent and received via MESH @@ -66,7 +77,7 @@ If you are building a system to receive bowel cancer screening test results, you Network access -You can access this API via: +You can access this integration via: the Health and Social Care Network (HSCN) the internet @@ -75,15 +86,15 @@ For more details see Network access for APIs. Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -The API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +The integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. Environments and testing -This API uses MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. +This integration uses MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. For more details about using the MESH client, see MESH client. @@ -93,13 +104,13 @@ Onboarding You must get your software onboarded before it can go live. The onboarding process can sometimes be quite long, so it's worth planning well ahead. -This API has a specific onboarding process for new market entrant GP IT developers. This applies whether you are integrating with it directly or using our Lab results adaptor. Contact your GP IT delivery lead for more details. +This integration has a specific onboarding process for new market entrant GP IT developers. This applies whether you are integrating with it directly or using our Lab results adaptor. Contact your GP IT delivery lead for more details. For other use cases, contact us. Interactions -For a full list of interactions for this API, see ISB 1557 EDIFACT Pathology Messaging but with the changes specified in 'Electronic GP Communication Requirements for GPSoC Software Suppliers Draft', under 'Additional guidance' below. +For a full list of interactions for this integration, see ISB 1557 EDIFACT Pathology Messaging but with the changes specified in 'Electronic GP Communication Requirements for GPSoC Software Suppliers Draft', under 'Additional guidance' below. You can also use our Lab Results adaptor to receive these EDIFACT results via an easy-to-use FHIR-compliant format.  @@ -115,4 +126,4 @@ Electronic GP Communication Requirements for GPSoC Software Suppliers Draft DOC 214 KB -Last edited: 26 May 2022 4:03 pm \ No newline at end of file +Last edited: 13 October 2022 4:42 pm \ No newline at end of file diff --git a/baselineTexts/cancer-outcomes-and-services-data-set.txt b/baselineTexts/cancer-outcomes-and-services-data-set.txt new file mode 100644 index 0000000..a758b0f --- /dev/null +++ b/baselineTexts/cancer-outcomes-and-services-data-set.txt @@ -0,0 +1,90 @@ +DCB1521: Cancer Outcomes and Services Data set + +The national standard for reporting cancer in the NHS in England + +Page contents +Top of page +About this information standard +Current release +Previous releases +About this information standard + +The Cancer Outcomes and Services Data set (COSD) provides the national standard for reporting activity to support implementation and monitoring of Improving Outcomes: a Strategy for Cancer (IOSC). + +Version 9.0 introduces a number of changes including a split into two distinct data sets, COSD v9 (excluding all pathological elements) and COSD Pathology v4. All changes are detailed in the Change Request below. + +These changes should be implemented by 1 April 2020, with full conformance required by 1 July 2020. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Version 9.0 +Release date + 12 September 2019 +Release number Amd 13/2019 +Release title Version 9.0 +Stage Implementation +Key documents +Change Request (Amd 13/2019) +Specification (Amd 13/2019) [Archive Content] +Implementation Guide (Amd 13/2019) +Information Standards Notice (Amd 13/2019) + +Supporting documents +NHS Data Model and Dictionary Change Request 1714 (Amd 13/2019)  +NHS Data Model and Dictionary Change Request 1714 (Full) (Amd 13/2019) +XML Schema (external site; login required) + +Further information   + +More information can be found at PHE: National Cancer Intelligence Network (external link) + +or please contact the COSD Help Desk - cosd@phe.gov.uk + +Previous releases +Version 8.0 +Release date 28/09/2017 +Release number Amd 74/2016 +Release title Version 8.0 +Stage Maintenance +Key documents +Change Specification (Amd 74/2016) +Requirements Specification (Amd 74/2016) [Archive Content] +Implementation Guidance (Amd 74/2016) +Information Standards Notice (Amd 74/2016) +Corrigendum (Amd 74/2016) + +Supporting documents +NHS Data Model and Dictionary Change Request 1588 (Amd 74/2016)  +NHS Data Model and Dictionary Change Request 1588 (Full) (Amd 74/2016) +XML Schema (Amd 74/2016) +Version 7.0 +Release date 17/08/2016 +Release number Amd 1/2016 +Release title Version 7.0 +Stage Retirement +Key documents +Requirements Specification (Amd 1/2016) [Archive Content] +Implementation Guidance (Amd 1/2016) +Change Request (Amd 1/2016) +Information Standards Notice (Amd 1/2016) + +Supporting documents +NHS Data Model and Dictionary Change Request 1564 (Amd 1/2016) +NHS Data Model and Dictionary Change Request Data Set 1564 (Full) (Amd 1/2016) +Version 6.0 +Release date 19/02/2015 +Release number Amd 17/2014 +Release title Version 6.0 +Stage Retirement +Key documents +Information Standards Notice (Amd 17/2014) +Specification (Amd 17/2014) +Change Specification (Amd 17/2014) +Implementation Guidance (Amd 17/2014) + +Supporting documents +NHS Data Model and Dictionary Change Request 1492 (Amd 17/2014) +NHS Data Model and Dictionary Change Request Dataset 1492 (Full) (Amd 17/2014) + +Last edited: 11 October 2019 11:14 am \ No newline at end of file diff --git a/baselineTexts/care-homes-view-of-shared-care-records.txt b/baselineTexts/care-homes-view-of-shared-care-records.txt index abd31e4..e5d869c 100644 --- a/baselineTexts/care-homes-view-of-shared-care-records.txt +++ b/baselineTexts/care-homes-view-of-shared-care-records.txt @@ -31,6 +31,7 @@ Royal College of Nursing Royal College of Occupational Therapists Royal College of Physicians Royal Pharmaceutical Society +View the standard Care homes view of shared care records V1.1 V1.1 View the standard V1.1 Download the standard (xlsx file) @@ -45,9 +46,4 @@ IHRIM record correction guidance Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. -VIEW THE GUIDANCE -IHRIM record correction guidance - -Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. - VIEW THE GUIDANCE \ No newline at end of file diff --git a/baselineTexts/child-protection-information-sharing-smsp-api-standards.txt b/baselineTexts/child-protection-information-sharing-smsp-api-standards.txt new file mode 100644 index 0000000..719ad4f --- /dev/null +++ b/baselineTexts/child-protection-information-sharing-smsp-api-standards.txt @@ -0,0 +1,179 @@ +Child Protection - Information Sharing - SMSP API standards + +Become a Spine Mini Service Provider giving access to child protection information from Child Protection - Information Sharing (CP-IS) for an unscheduled care provider using our SMSP API standards. + +Page contents +Top of page +Overview +Who can use this API +Related APIs +API status +Technology +Network access +Security and authorisation +Testing +Onboarding +Interactions +Downloads +Overview + +Become a Spine Mini Service Provider giving access to child protection information from Child Protection - Information Sharing (CP-IS) for an unscheduled care provider using our SMSP API standards. CP-IS is the national electronic database of child protection information. + +Your commercially available Spine Mini Service Providers (SMSP) product will give access to CP-IS for your SMSP clients. We will list your SMSP provider service along with other conforming software products in our Conformance Catalogue. + +Before you begin any development work using these API standards, contact us to discuss your best options. + +These API standards can be used by unscheduled care providers as follows: + +Unscheduled Care Application +CP-IS +Unscheduled Care +User + +1. request CP-IS information +4. receive CP-IS information + + +CP-IS Data +CP-IS +SMSP Provider +(External developer) + +2. request CP-IS information +3. receive CP-IS information + +NHS Spine +CP-IS system +Unscheduled care providers + +As an unscheduled care provider, your CP-IS SMSP clients can: + +get a patient's CP-IS information, which automatically triggers a notification to the relevant local authority. + +These SMSP API standards are easier for SMSP clients to use than our CP-IS HL7 V3 API because: + +they have fewer security requirements (for example, NHS smartcards are not required) +the onboarding process is simpler (see Onboarding below) +Scheduled care providers + +CP-IS SMSP client access is not currently available for use in scheduled care settings. + +Local authorities + +CP-IS SMSP client access is not available to local authorities. + +Information held in CP-IS + +CP-IS holds the following information for each registered patient: + +NHS number +details of their plan - type, start date and end date +details of the 25 most recent CP-IS information accesses from unscheduled care settings in England +the name of the responsible local authority - together with their office hours phone and emergency duty contact numbers +Identifying patients + +All records in CP-IS are held against the patient's NHS number. It is therefore very important to ensure you use the correct NHS number for each patient. + +For more details, see CP-IS NHS number matching information. + +Using SCRa as an interim measure + +We prefer unscheduled care providers to integrate their applications directly with CP-IS using our CP-IS HL7 V3 API or these API standards. However, as an interim measure, you also can use our Summary Care Record application (SCRa) to access CP-IS information. + +Who can use this API + +These API standards can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. + +You must do this before you can go live (see ‘Onboarding’ below).  + +Related APIs + +The following APIs are related to these API standards: + +Personal Demographics Service - FHIR API - use this to find the correct NHS number for a given patient +Child Protection - Information Sharing - HL7 V3 API - use this for the full features of our HL7 V3 API +API status + +These API standards are stable. + +Technology + +These API standards are based on our CP-IS HL7 V3 API but with a simplified read-only model and synchronous interactions. + +For more details, see HL7 V3. + +Network access + +You need a Health and Social Care Network (HSCN) connection to use these API standards. + +For more details, see Network access for APIs. + +Security and authorisation + +For unscheduled care providers, these API standards are application-restricted, meaning the calling application is authenticated but the end user is either not authenticated or not present. + +In particular, these API standards use TLS-MA authentication. + +For more details on authentication, see application-restricted APIs. + +Even though these API standards do not technically require the end user to be authenticated, a condition of onboarding is that the calling application must: + +authenticate the end user locally +use local role-based access controls to authorise the end user + +For more details on the calling application requirements, see DCB1609: Child Protection - Information Sharing. + +Testing + +You can test these API standards using our Path to Live environments. + +Onboarding + +You must get your software onboarded before it can go live. + +As part of onboarding, these API standards use the Target Operating Model (TOM) process, which is simpler than the traditional Common Assurance Process (CAP). + +Note that in addition to SMSP provider software assurance, for clinical safety reasons, we also need to assure your SMSP clients. + +For more details, and to get a copy of the latest TOM forms to complete, contact the interoperability conformance team on itkconformance@nhs.net. + +Interactions + +For details of SMSP provider interactions, see the following downloads: + +SMSP Common Provider Requirements V1.1 - 23/09/2014 PDF +CP-IS SMSP Provider Requirements V1.1 - 09/12/2014 PDF + +For details of SMSP client interactions, to share with your clients, see the following downloads: + +SMSP Common Client Requirements - 23/09/2014 PDF +CP-IS SMSP Client Requirements - 15/07/2014 PDF + +Both SMSP providers and SMSP clients need the same response codes: + +SMSP Response Codes - 24/07/2014 XLS +Downloads + +These are PDF and Microsoft Excel files. To request a different format, contact us. + +SMSP Common Provider Requirements V1.1 - 23/09/2014 PDF + +PDF 718 KB + +CP-IS SMSP Provider Requirements V1.1 - 09/12/2014 PDF + +PDF 678 KB + +SMSP Common Client Requirements - 23/09/2014 PDF + +PDF 663 KB + +CP-IS SMSP Client Requirements - 15/07/2014 PDF + +PDF 565 KB + +SMSP Response Codes - 24/07/2014 XLS + +XLSX 17 KB + +Last edited: 13 October 2022 4:56 pm \ No newline at end of file diff --git a/baselineTexts/child-protection-information-sharing.txt b/baselineTexts/child-protection-information-sharing.txt index b846e45..5ef483a 100644 --- a/baselineTexts/child-protection-information-sharing.txt +++ b/baselineTexts/child-protection-information-sharing.txt @@ -48,7 +48,7 @@ Release number Amd 27/2013 Release title Initial Standard Stage Superseded by Amd 113/2018 Key documents -Standard Specification (Amd 27/2013) +Standard Specification (Amd 27/2013) [Archive Content] Implementation Guidance (Amd 27/2013) Information Standards Notice (Amd 27/2013) @@ -56,4 +56,4 @@ Information Standards Notice (Amd 27/2013) (Version 2)   -Last edited: 11 February 2022 9:51 am \ No newline at end of file +Last edited: 27 September 2022 5:40 pm \ No newline at end of file diff --git a/baselineTexts/chlamydia-testing-activity-dataset.txt b/baselineTexts/chlamydia-testing-activity-dataset.txt new file mode 100644 index 0000000..f1aa926 --- /dev/null +++ b/baselineTexts/chlamydia-testing-activity-dataset.txt @@ -0,0 +1,2046 @@ +Standards and collections + +An alphabetical list of all current approved national information standards and data collections (including extractions). + +Page contents +Top of page +Approved standards and collections +Current standards and collections +How to use the list +Other resources +Approved standards and collections + +This list shows all current Data Alliance Partnership Board (DAPB) approved national information standards and data collections (including extractions) (known as ISCE) for use in health and adult social care.  + +The list is updated on a monthly basis following the approval of new items, and changes, by the DAPB. + +Current standards and collections +Title + +ISCE + +Documentation + + + +Accessible Information + + + +Standard + + + +DCB1605 Guidance (NHS England and NHS Improvement) + + +Adolescent Vaccine Coverage data Collection DAPB0133 Guidance (UK Health Security Agency) + + +Adult Social Care Finance Return + + + +Collection + + + +DCB2135 Guidance (NHS Digital) + + +Adult Social Care Workforce Data Set Collection DCB2143 Guidance (Department of Health and Social Care) +Aggregate Contract Monitoring Standard and a Collection DCB2050 Guidance (NHS England and NHS Improvement)  + + +AIDC for Patient Identification + + + +Standard + + + +DCB1077 Guidance (NHS Digital) + + + + +AIDC: Automatic Identification and Data Capture + + + +Standard + + + +DAPB0108 Guidance (NHS Digital) + + +Alcohol Dependence Programme Patient Level Data Collection Collection DAPB4044 Guidance (NHS Digital) +Ambulance Data Set Collection DAPB3107 Guidance (NHS Digital) + + +Ambulance Electronic Patient Report + + + +Standard + + + +ISB 1516 Guidance + + +Ambulance Services: Computer Aided Dispatch Data Collection DCB3088 documentation + + +Ambulance Quality Indicators - Clinical Outcomes + + + +Collection + + + +DCB3028-01 Guidance (NHS Digital) + + + + +Ambulance Quality Indicators - Systems Indicators + + + +Collection + + + +DCB3028-02 Guidance (NHS Digital) + + +Antibiotic Consumption Data Collection DCB3063 Guidance (NHS England and NHS Improvement) + + +Annual GP Practice electronic Self Declaration (eDEC) + + + +Collection + + + +DCB2053 Guidance (NHS Digital) + + + + +Anonymisation Standard for Publishing Health and Social Care Data + + + +Standard + + + +ISB 1523 Guidance + + + + +Assuring Transformation + + + +Standard and a Collection + + + +DCB2007 Guidance (NHS England and NHS Improvement) + + +Better Care Fund Quarterly Reporting Collection DCB3067 Guidance (NHS England and NHS Improvement) + + +Birth Notifications + + + +Standard + + + +ISB 1555 Guidance + + +Board Vacancies and Commercial Spend Collection DAPB4009 documentation + + +Breast and Cosmetic Implant Registry + + + +Collection + + + +SCCI2132 Guidance (NHS Digital) + + + + +Breast Screening Programme Data Set (KC63 and KC62) + + + +Standard and a Collection + + + +ISB 1597 Guidance + + + + +British Society of Surgery of the Hand (BSSH) Audit + + + +Collection + + + +DCB2196 Guidance (The British Society for Surgery of the Hand (BSSH) Members Area) + + + + +Cancer Outcomes and Services Data set, Version 8.0 + + + +Standard and a Collection + + + +DCB1521 Guidance (Public Health England) + + +Cancer Quality of Life (QoL) Metric survey Collection DCB3102 Guidance (NHS England and NHS Improvement) + + +Cancer Patient Experience Survey + + + +Collection + + + +DCB2116 Guidance (NHS England and NHS Improvement) + + + + +Cancer Patient Tracking List (PTL) + + + +Collection + + + +DAPB3037 Guidance (NHS Digital) + + + + +Cataract Data Set + + + +Standard and a Collection + + + +ISB 0085 Guidance + + + + +CCG Digital Maturity Questionnaire + + + +Collection + + + +DAPB2167 Guidance (NHS Digital) + + + + +Child Protection Information Sharing + + + +Standard + + + +DCB1609 Guidance (NHS Digital) + + + + +Childhood Influenza Vaccination Programme Primary School Age Children + + + +Collection + + + +DCB2195 Guidance (Public Health England) + + + + +Childhood Measurement Central Return + + + +Standard and a Collection + + + +ISB 0146 Guidance + + + + +Children and Young People (CYP) with an Eating Disorder Referral to Treatment Times (RTT) + + + +Collection + + + +SCCI2185 Guidance (NHS Digital) + + + + +Chlamydia Testing Activity Dataset + + + +Standard and a Collection + + + +SCCI1538 Guidance (Public Health England) + + + + +Clinical Risk Management: its Application in the Deployment and Use of Health IT Systems + + + +Standard + + + +DCB0160 Guidance (NHS Digital) + + + + +Clinical Risk Management: its Application in the Manufacture of Health IT Systems + + + +Standard + + + +DCB0129 Guidance (NHS Digital) + + + + +Commissioning Data Sets (CDS) + + + +Standard and a Collection + + + +DAPB0092 Guidance (NHS Digital) + + + + +Commissioning Data Sets (CDS) Version 6.2.3: Emergency Care Data Set (ECDS) + + + +Standard and a Collection + + + +DCB0092-2062 Guidance (NHS Digital) + + +Community Health Staff data collection Collection DCB3095 documentation + + +Community Pharmacy Contractual Framework National Audit + + + +Collection + + + +DCB2103 documentation + + + + +Community Services Data Set + + + +Standard and a Collection + + + +DAPB1069 Guidance (NHS Digital) + + +Compliance with National Data Opt-outs Standard DCB3058 Guidance (NHS Digital) + + +Conflict of Interest Indicator + + + +Collection + + + +DCB2221 Guidance (NHS England and NHS Improvement) + + +Consultant-led Referral to Treatment (RTT) Waiting Times Standard and a Collection DCB0095 Guidance (NHS Digital) +Corporate Services annual data collection Collection DAPB4006 (no guidance published) NHS England and NHS Improvement + + +Cover of Vaccination Evaluated Rapidly (COVER) Return + + + +Standard and a Collection + + + +DAPB0089 Guidance (UKHSA) + + +COVID-19: Bulk capture of COVID-19 vaccinations data collection Collection DAPB4036 (no guidance published) NHS England and NHS Improvement +COVID-19: Community Daily Discharge Situation Report (SitRep) Collection DCB3136 Guidance (NHS Digital) +COVID-19: Community Health Services Situation Report (SitRep) Collection DAPB3132 Guidance (NHS Digital) +COVID-19: Daily Discharge Situation Report (SitRep) Collection DCB3129 Guidance (NHS Digital) +COVID-19: ICU Consumables Stocktake: Renal Stocktake Collection DCB3122 (no guidance published) NHS England and NHS Improvement +COVID-19: Independent Sector Provider (ISP) Weekly Activity Situation Report (SitRep) Collection DCB3139 Guidance (NHS Digital) +COVID-19: Independent Sector Provider (ISP) Diagnostics and Cancer Treatments Daily Situation Report (SitRep) Collection DCB3138 (no guidance published) NHS England and NHS Improvement +COVID-19: Long COVID Assessment Services Data Collection DCB3135 Guidance (NHS Digital) +COVID-19: Maternity COVID Service Alterations Situation Report (SitRep)  Collection DAPB4067 (no guidance published) NHS England and NHS Improvement +COVID-19: NHS Staff Lateral Flow Testing Collection DCB3137 Guidance (NHS Digital) +COVID-19: NHS Weekly Activity Return Collection DCB3142 Guidance (NHS Digital) +COVID-19: Theatre Productivity data collection Collection DAPB4028 documentation + + +CQC provider survey + + + +Collection + + + +DAPB3030 (no guidance published) CQC  + + +CQUIN consolidated data collection Collection DAPB2239 Guidance (NHS England and NHS Improvement) + + +Critical Care Minimum Data Set + + + +Standard and a Collection + + + +ISB 0153 Guidance + + + + +Daily 111 Winter Collection + + + +Collection + + + +DCB3056 Guidance (NHS Digital) + + + + +Database for the National Latent Tuberculosis Screening Programme in New Migrants from High-incidence Countries + + + +Collection + + + +SCCI2108 Guidance (Public Health England) + + + + +Data Security and Protection Toolkit + + + +Standard and a Collection + + + +DAPB0086 Guidance (NHS Digital) + + + + +Delayed Transfers of Care + + + +Collection + + + +DCB3032 Guidance (NHS Digital) + + +Dental Working Patterns Collection DCB3027 Guidance (NHS Digital) + + +Deprivation of Liberty Safeguards (DoLS), under the Mental Capacity Act 2005, Data Collection + + + +Collection + + + +DAPB2101 Guidance (NHS Digital) + + +Devices Patient Level Contract Monitoring Standard and a Collection DCB3002 Guidance (NHS England and NHS Improvement) + + +Diabetic Retinopathy Screening Data Set + + + +Standard and a Collection + + + +ISB 0073 Guidance + + + + +Diagnostic Imaging Data Set + + + +Standard and a Collection + + + +SCCI1577 Guidance (NHS Digital) + + + + +Diagnostics Waiting Times and Activity Monthly Return + + + +Collection + + + +DCB0103-01 Guidance (NHS Digital) + + + + +Dictionary of Medicines and Devices (dm+d) + + + +Standard + + + +SCCI0052 Guidance (NHS Digital) + + + + +Digital Imaging and Communications in Medicine (DICOM) + + + +Standard + + + +ISB 1556 Guidance + + +Digital Maternity Record Standard Standard DCB3066 Guidance (NHS Digital) + + +Direct Access Audiology Priority Treatment List (PTL) and Waiting Times (WT) Dataset + + + +Collection + + + +DCB0127 Guidance (NHS Digital) + + +Drugs Patient Level Contract Monitoring Standard and a Collection DCB2212 Guidance (NHS England and NHS Improvement) +Early Childhood Baseline (DTaP/IPV/Hib+HepB, At-Risk Hepatitis B and Early MMR) Extraction DAPB4046 (no guidance published) UKHSA + + +EDIFACT Pathology Messaging + + + +Standard + + + +ISB 1557 Guidance + + + + +Electronic Yellow Card Reporting, Version 3.0 + + + +Standard + + + +DCB1582 Guidance (Medicines and Healthcare products Regulatory Agency (MHRA)) + + + + +eMED3 (fit notes) + + + +Collection + + + +SCCI2118 Guidance (NHS Digital) + + + + +Estates Return information Collection (ERIC) + + + +Collection + + + +DAPB2083 Guidance (NHS Digital) + + + + +Female Genital Mutilation Enhanced Dataset + + + +Standard and a Collection + + + +SCCI2026 Guidance (NHS Digital) + + +FFP3 resilience data collection Collection DAPB4055 (no guidance published) Department of Health and Social Care + + +FGM - Information Sharing (FGM-IS) Local System Integration + + + +Standard + + + +DCB2112 Guidance (NHS Digital) + + + + +Fill Rate Indicator Return, Staffing, Nursing, Midwifery, Allied Health Professional and Care Staff + + + +Collection + + + +DCB2039 Guidance (NHS Digital) + + +Fleet data for Model Ambulance Collection DAPB4035 (no guidance published) NHS England and NHS Improvement) + + +Friends and Family Test + + + +Collection + + + +DCB2054 Guidance (NHS Digital) + + +Friends and Family Test: Post-COVID Assessment Clinics Collection DAPB2054-4026 Guidance (NHS England and NHS Improvement) +Friends and Family Test: Quarterly Staff Survey (National Quarterly Pulse Survey (NQPS))  Collection DAPB2054-3144 Guidance (NHS Digital) +General Practice and Primary Care Network Workforce Collection DAPB4034 (no guidance published) Department of Health and Social Care +General Practice (including Dental) Complaints (KO41b) Collection DAPB2126 Guidance (NHS Digital) +General Practice Pay Transparency Collection DAPB4023 Guidance (NHS England and NHS Improvement) + + +Genetic Testing Rates + + + +Collection + + + +SCCI2035 Guidance (NHS Digital) + + + + +GP Appointments + + + +Collection + + + +DCB3018 Guidance (NHS Digital) + + + + +GP Workload Tool + + + +Collection + + + +DAPB2236 Guidance (NHS Digital) + + +GPES: 6-in-1 vaccination programme Extraction DCB2090-3141 Guidance (NHS Digital) +GPES: Cardiovascular Disease Prevention Audit +(CVDPREVENT) Extraction DCB2090-3109 documentation + + +GPES: Childhood Seasonal Influenza Vaccination Programme + + + +Extraction + + + +DAPB2090-2206 Guidance (NHS Digital) + + + + +GPES: Core Contract + + + +Extraction + + + +DAPB2090-3010 Guidance (NHS Digital) + + +GPES: COVID-19 At Risk Patients data collection Extraction DCB2090-3114 Guidance (NHS Digital) + + +GPES: Indicators no longer in the Quality and Outcomes Framework (QOF) + + + +Extraction + + + +DAPB2090-2232 Guidance (NHS Digital) + + +GPES: Learning Disabilities Data Extraction DAPB2090-2171 Guidance (NHS Digital) + + +GPES: Learning disabilities health check scheme + + + +Extraction + + + +DAPB2090-2191 Guidance (NHS Digital) + + + + +GPES: Meningococcal ACWY Vaccination Programme + + + +Extraction + + + +DAPB2090-2133 Guidance (NHS Digital) + + + + +GPES: Meningococcal B Vaccination Programme + + + +Extraction + + + +DAPB2090-2187 Guidance (NHS Digital) + + +GPES: Network Contract Directed Enhanced Services (DES)    Extraction DAPB2090-3084 Guidance (NHS Digital) +GPES: PCV HIB MenC Vaccination Programme Extraction DAPB2090-2225 Guidance (NHS Digital) + + +GPES: Pertussis in pregnant women vaccination programme + + + +Extraction + + + +DCB2090-2180 Guidance (NHS Digital) + + +GPES: Physical Health Checks for People with Serious Mental Illness Extraction DCB2090-3038 Guidance (NHS Digital) + + +GPES: Pneumococcal polysaccharide vaccination programme + + + +Extraction + + + +DAPB2090-2181 Guidance (NHS Digital) + + + + +GPES: Quality and Outcomes Framework (QOF) + + + +Extraction + + + +DAPB2090-2183 Guidance (NHS Digital) + + + + +GPES: Rotavirus (routine childhood immunisation) Vaccination Programme + + + +Extraction + + + +DAPB2090-2182 Guidance (NHS Digital) + + + + +GPES: Seasonal Influenza Vaccination Programme + + + +Extraction + + + +DAPB2090-2207 Guidance (NHS Digital) + + + + +GPES: Shingles Combined Vaccination Programme + + + +Extraction + + + +DAPB2090-2208 Guidance (NHS Digital) + + +Greener NHS - Fleet data collection Collection DAPB4058 Guidance (NHS England and NHS Improvement) (login required) +Greener NHS quarterly data collection Collection DAPB4062 (no guidance published) NHS England and NHS Improvement + + +GUMCAD STI Surveillance System + + + +Standard and a collection + + + +DCB0139 Guidance (Public Health England) + + + + +HA/GP Links + + + +Standard + + + +ISB 1558 Guidance + + + + +Health and Social Care Organisation Reference Data + + + +Standard + + + +DAPB0090 Guidance (NHS Digital) + + + + +Healthcare Resource Groups (HRG) + + + +Standard + + + +ISB 0070 Guidance + + + + +Healthy Child Programme  + + + +Standard  + + + +DAPB3009 Guidance (NHS Digital) + + + + +Hepatitis B (new born) Babies Vaccination Programme (CQRS) + + + +Extraction + + + +DCB2090-2178 Guidance (NHS Digital) + + + + +HIV and AIDs Reporting System (HARS) + + + +Standard and a Collection + + + +SCCI1570 Guidance (Public Health England) + + + + +Hospital and Community Health Services Written Complaints Collection (KO41a) + + + +Collection + + + +SCCI2125 Guidance (NHS Digital) + + + + +HPV Booster Vaccination Programme (CQRS) + + + +Collection + + + +DCB2176 Guidance (NHS Digital) + + + + +Identity Verification and Authentication Standard for Digital Health and Care Services + + + +Standard + + + +DCB3051 Guidance (NHS Digital) + + + + +Improving Access to Psychological Therapies Data Set + + + +Standard and a Collection + + + +DAPB1520 Guidance (NHS Digital) + + +Influenza and COVID-19 vaccine uptake in Frontline Healthcare Workers (HCWs) survey Collection DAPB2204 Guidance (Public Health England) + + +Information Governance Standards Framework + + + +Standard + + + +ISB 1512 Guidance + + + + +ISB 1594 Guidance + + + + +Integrated Urgent Care Aggregate Data Collection + + + +Collection + + + +DAPB3031 Guidance (NHS Digital) + + +Integrated Urgent Care Forecasting and Capacity Planning Collection DCB3076 documentation +Integrating Flu/ COVID Hospitalisation Surveillance Collection DCB2043 (no guidance published)  + + +Interim Clinical Imaging Procedure Codes + + + +Standard + + + +ISB 0148 Guidance + + + + +International Statistical Classification of Diseases and Related Health Problems (ICD-10) + + + +Standard + + + +SCCI0021 Guidance (NHS Digital) + + + + +Inter-Provider Transfer Administrative Minimum Data Set + + + +Standard + + + +ISB 0112 Guidance + + + + +Junior Doctors – Rota Notification + + + +Collection + + + +DCB3042 Guidance (NHS Digital) + + + + +KH03: Bed Availability and Occupancy + + + +Collection + + + +DCB1576 Guidance (NHS Digital) + + +Legal Services Target Operating Model (LSTOM) data collection Collection DAPB4007 (no guidance published) NHS England and NHS Improvement +Long Length of Stay Discharge Patient Tracking List Collection DCB3079 Guidance (NHS Digital) + + +Maternity Services Data Set + + + +Standard and a Collection + + + +DCB1513 Guidance (NHS Digital) + + +Measles, Mumps and Rubella (MMR) vaccine coverage collection Extraction DAPB4049 (no guidance published) UKHSA + + +Measles, Mumps, Rubella (MMR) Vaccination Programme (CQRS) + + + +Collection + + + +DAPB2179 Guidance (NHS Digital) + + +Medical Revalidation Annual Organisational Audit Collection DCB3077 Guidance (NHS England and NHS Improvement) +Medication in Children and Young People Inpatient Audit Collection DAPB4056 (no guidance published) NHS England and NHS Improvement +Medicine and Allergy/Intolerance Data Transfer Standard DAPB4013 Guidance (NHS Digital) +Meningococcal ACWY (MenACWY) vaccine coverage vaccine coverage collection Extraction DAPB4047 (no guidance published) UKHSA +Meningococcal B (MenB) vaccine coverage vaccine coverage collection Extraction DAPB4048 (no guidance published) UKHSA + + +Mental Health Services Data Set + + + +Standard and a Collection + + + +DCB0011 Guidance (NHS Digital) + + +Mental Health Staff data collection Collection DCB3089 documentation + + +Mixed-Sex Accommodation + + + +Collection + + + +DCB1573 Guidance (NHS Digital) + + +Model Health System procurement metrics Collection DAPB4061 (no guidance published ) NHS England and NHS Improvement + + +Monthly Referral Return + + + +Collection + + + +DCB3023-01 Guidance (NHS England and NHS Improvement) + + + + +Monthly Situation Report – Critical Care and Urgent Cancelled Operations + + + +Collection + + + +DCB3025 Guidance (NHS Digital) + + + + +Monthly Situation Report – Emergency Care + + + +Collection + + + +DCB1607 Guidance (NHS Digital) + + + + +National Cancer Waiting Times Monitoring Data Set + + + +Standard and a Collection + + + +DCB0147 Guidance (NHS Digital) + + +National COVID-19 Chest Imaging Database (NCCID) Collection DAPB4032 Guidance (NHSX) + + +National Diabetes Audit + + + +Collection + + + +DCB2235-01 Guidance (NHS Digital) + + + + +National Diabetes Footcare Audit + + + +Collection + + + +DCB2235-03 Guidance (NHS Digital) + + +National Diabetes Inpatient Safety Audit (NDISA) + +Collection + + + +DCB2235-05 Guidance (NHS Digital)  + + + + +National Drug and Alcohol Treatment Monitoring System (NDTMS) Data Set + + + +Standard and a Collection + + + +DAPB0107 Guidance (Public Health England) + + + + +National Joint Registry Data Set + + + +Standard and a Collection + + + +DCB1567 Guidance (National Joint Registry (NJR)) + + + + +National Pregnancy in Diabetes Audit + + + +Collection + + + +DCB2235-02 Guidance (NHS Digital) + + +National Waiting List Weekly Minimum Data Set Collection DCB3145 documentation +National Wheelchair Data Collection Collection DCB2097 Guidance (NHS Digital) + + +National Workforce Data Set + + + +Standard + + + +DAPB1067 Guidance (NHS Digital) + + + + +Neonatal Critical Care Minimum Data Set + + + +Standard and a Collection + + + +SCCI0075 Guidance (NHS Digital) + + + + +Neonatal Data Set + + + +Standard and a Collection + + + +DAPB1595 Guidance (Imperial College London) + + +NHS Continuing Healthcare (CHC) Deferred Assessments SitRep Collection DCB3127 Guidance (NHS Digital) +NHS Continuing Healthcare (CHC) Patient-Level Data Set Standard and a Collection DCB3085 Guidance (NHS Digital) + + +NHS Continuing Healthcare quarterly collection + + + +Collection + + + +DCB2117 Guidance (NHS Digital) + + + + +NHS 111 Pathways + + + +Collection + + + +DCB2228 documentation + + + + +NHS 111 Patient Experience Survey + + + +Collection + + + +DAPB3029 Guidance (NHS Digital) + + +NHS Health Care Worker (HCW) CCG COVID-19 vaccination uptake SitRep Collection DAPB3146-01 documentation +NHS Health Care Worker (HCW) Trust COVID-19 vaccination uptake SitRep Collection DAPB3146-02 documentation + + +NHS Health Check + + + +Standard and a Collection + + + +ISB 1080 Guidance + + + + +NHS Number + + + +Standard + + + +ISB 0149 Guidance + + + + +NHS Number for General Practice + + + +Standard + + + +ISB 0149-01 Guidance + + + + +NHS Number for Secondary Care + + + +Standard + + + +ISB 0149-02 Guidance + + +NHS Premises Assurance Model online system Collection DAPB4021 Guidance (NHS England and NHS Improvement) +NHS Staff Survey Collection DAPB3078 Guidance (NHS England and NHS Improvement) +NHS Surplus Land Collection DCB2154 Guidance (NHS Digital) +NHS Trust and CCG Governing Bodies - 2020 Board Membership and Diversity Survey (England) Collection DCB3133 documentation +Non-Emergency Patient Transport Services Data Set Collection DAPB4030 (no guidance published) NHS England and NHS Improvement +Online and Video Consultation in General Practices Collection DAPB4031 Guidance (NHS Digital) + + +OPCS Classification of Interventions and Procedures + + + +Standard + + + +DCB0084 Guidance (NHS Digital) + + + + +Out of Area Placements (OAPs) + + + +Collection + + + +SCCI2213 Guidance (NHS Digital) + + + + +Overseas Visitor Charging Category (OVCC) + + + +Standard + + + +DCB3017 Guidance (NHS Digital) + + + + +Paediatric Critical Care Minimum Data Set + + + +Standard and a Collection + + + +SCCI0076 Guidance (NHS Digital) + + + + +Palliative Care Co-ordination: Core Content + + + +Standard + + + +SCCI1580 Guidance (Public Health England) + + +Pathology Test and Results Standard Standard DAPB4017 Guidance (NHS Digital) + + +Patient Identifiers for Identity Bands + + + +Standard + + + +ISB 0099 Guidance + + + + +Patient-Led Assessments of the Care Environment (PLACE) + + + +Collection + + + +DAPB2085 Guidance (NHS Digital) + + +Patient Level Contract Monitoring Standard and a Collection DCB3003 Guidance (NHS England and NHS Improvement) +Patient Level Information and Costing Systems (PLICS) Integrated Data Set Standard and a Collection DAPB4000 Guidance (NHS England and NHS Improvement) +Patient-Level Information and Costing Systems (PLICS) Ambulance Data Set Standard and a Collection DAPB4001 Guidance (NHS England and NHS Improvement) + + +Personal Health Budgets + + + +Collection + + + +DCB2184 Guidance (NHS Digital) + + +Personal Social Services Adult Social Care Survey, England Collection DAPB2153 Guidance (NHS Digital)  + + +Personal Social Services Survey of Adult Carers in England + + + +Collection + + + +DAPB2169 Guidance (NHS Digital) + + +Personalised Care and Support Plan Standard DAPB4022 Guidance (Professional Record Standards Body (PRSB)) + + +Physical healthcare for people with serious mental illness (SMI): Primary care data collection + + + +Collection + + + +DCB3038 Guidance (NHS Digital) + + +Physiological Measurements Services data collection Collection DAPB4043 (no guidance published) NHS England and NHS Improvement +Plastics Reduction Pledge Collection DCB3091 Guidance (NHS England and NHS Improvement)  +Pneumococcal Polysaccharide Vaccine (PPV) vaccine coverage collection Extraction DAPB4050 (no guidance published) UKHSA +Post-COVID Assessment Clinic Patient List Collection DAPB4027 Guidance (NHS England and NHS Improvement) (login required) +Prenatal Pertussis vaccine coverage collection Extraction DAPB4037 (no guidance published) UKHSA + + +Prevent Training Reports + + + +Collection + + + +SCCI2193 Guidance (NHS Digital)  + + + + +Primary care Commissioning Activity Report (PCAR) + + + +Collection + + + +DCB2197 Guidance (NHS Digital) + + +Primary Care Monitoring Survey Collection DAPB3128 Guidance NHS England and NHS Improvement (login required) + + +Programme Budgeting + + + +Collection + + + +DCB3007 documentation + + +Provider Elective Recovery Outpatient Collection (Provider EROC) Collection DAPB4033 Guidance (NHS England and NHS Improvement) (login required) +Public Health Specialist Workforce data collection Collection DCB3082 documentation +Public Sector Apprenticeship Target: Statutory annual reporting Collection DCB3071 Guidance (Department for Education) + + +Quarterly Monitoring Cancelled Operations + + + +Collection + + + +DCB0143 Guidance (NHS Digital) + + + + +Radiotherapy Data Set + + + +Standard and a Collection + + + +DAPB0111 Guidance (Public Health England) + + +Referral to Treatment (RTT) Weekly Patient Tracking List (PTL) Collection + +DCB3090 documentation + + +Rotavirus vaccine coverage collection Extraction DAPB4051 (no guidance published) UKHSA + + +Safeguarding Adults Collection (SAC) + + + +Collection + + + +DCB2172 Guidance (NHS Digital) + + +Safeguarding Case Review Tracker Collection DCB3124 documentation +Seasonal Influenza Vaccine Uptake (GP Patient) Survey (Main) + +Collection + + + +DCB2205 Guidance (Public Health England) + + +Seasonal Influenza Vaccine Uptake (GP Patient) Survey (Child) + +Collection + + + +DCB2211 Guidance (Public Health England) + + + + +Secure Email + + + +Standard + + + +DCB1596 Guidance (NHS Digital) + + + + +Seven Day Services Survey + + + +Collection + + + +SCCI2173 documentation + + + + +Sexual and Reproductive Health Activity Dataset + + + +Standard and a Collection + + + +SCCI1518 Guidance (Public Health England) + + + + +Sexual Orientation Monitoring + + + +Standard + + + +DCB2094 Guidance (NHS England and NHS Improvement) + + +Shingles annual vaccine coverage collection Extraction DAPB4053 (no guidance published) UKHSA +Shingles quarterly vaccine coverage collection Extraction DAPB4052 (no guidance published) UKHSA +Shingles Shingrix quarterly vaccine coverage collection Extraction DAPB4054 (no guidance published) UKHSA + + +Short and Long Term Return (SALT) + + + +Collection + + + +DAPB2161 Guidance (NHS Digital) + + + + +SNOMED CT + + + +Standard + + + +SCCI0034 Guidance (NHS Digital) + + + + +Specialised Services National Definitions Set + + + +Standard + + + +ISB 0005 Guidance + + +Spend Comparison: Accounts Payable data  Collection DCB3080-02 Guidance (NHS Digital) +Spend Comparison: Purchase Order data Collection DCB3080-01 Guidance (NHS Digital) +Staff Networks Maturity Framework Collection DAPB4040 (no guidance published) NHS England and NHS Improvement + + +Stop Smoking Service Quarterly Monitoring Return + + + +Collection + + + +DCB0155 Guidance (NHS Digital) + + +Sugar Sweetened Beverages collection Collection DCB3099 documentation +Surgical Devices and Implants Core Data Set Standard and a Collection DAPB3103 Guidance (NHS Digital) +Surgical Devices and Implants, Phase 1: Pelvic Floor Registry Collection DCB3103-01 Guidance (NHS Digital) + + +Surveillance of Healthcare Associated Infections + + + +Standard and a Collection + + + +DCB0134 Guidance (Public Health England) + + +System Elective Recovery Outpatient Collection (System EROC) Collection DAPB4039 Guidance (NHS England and NHS Improvement) (login required) + + +Systemic Anti-Cancer Therapy Data Set + + + +Standard and a Collection + + + +DCB1533 Guidance (Public Health England) + + +Tobacco Dependence Programme Patient Level Data Collection Collection DAPB4041 Guidance (NHS Digital) +Transfer of Care - Acute Inpatient Discharge  Standard DAPB4042 Guidance (NHS Digital) + + +Trauma Audit and Research Network Notification Data Set + + + +Standard and a Collection + + + +ISB 1606 Guidance + + +Treatment Function and Main Specialty Standard Standard DCB0028 Guidance (NHS Digital) +Under 16 Cancer Patient Experience Survey 2020-23 Collection DCB3131 Guidance (NHS England and NHS Improvement) +UK Core Fast Healthcare Interoperability Resources (FHIR) Release 4 (R4) Governance Standard DAPB4020 Guidance (NHS Digital) +Urgent and Emergency Mental Health Care and Intensive Home Treatment for Children and Young People – Third National Survey Collection DCB3093 documentation + + +Venous Thromboembolism (VTE) Risk Assessment + + + +Collection + + + +DCB1593 Guidance (NHS Digital) + + +Violence Against Staff Collection DCB3100 (no guidance published) NHS England and NHS Improvement +Virtual Wards data collection Collection DAPB4068 Guidance (NHS England and NHS Improvement) (login required) +Volunteer numbers supporting NHS Trusts Survey Collection DAPB4057 (no guidance published) NHS England and NHS Improvement + + +Weekly Diagnostic Activity Collection + + + +Collection + + + +SCCI2163 Guidance (NHS England and NHS Improvement) + + + + +Workforce Disability Equality Standard (WDES) + + + +Collection + + + +DAPB3048 Guidance (NHS England and NHS Improvement) + + + + +Workforce Race Equality Standard (WRES) + + + +Collection + + + +DAPB3040 Guidance (NHS Digital) + +How to use the list + +For each item you can see: + +title - the name of the standard or collection +ISCE - shows whether this is a standard or a collection +documentation - the reference number for the ISCE (a unique identifier with a prefix indicating who approved it) with a link to published guidance for the ISCE (where available) +Approvals and acceptance +Prefix Approved or accepted by +DAPB Data Alliance Partnership Board +DCB Data Coordination Board (legacy) +ISB Information Standards Board (legacy) +SCCI Standardisation committee for care information (legacy) +ISCE values +Value + +Meaning + +Standard an information standard +Standard and collection an information standard which incorporates a collection +Standard and an extraction an information standard which incorporates a data extraction +Collection a data collection +Extraction a data extraction +  +Other resources +ARTICLE + +Information Standards Notices + +Information Standards Notices (ISNs) are published to announce new or changes to information standards published under section 250 of the Health and Social Care Act 2012. + +ARTICLE + +Withdrawn standards and collections + +A list of withdrawn and deprecated information standards and collections. + +ARTICLE + +Publications and notifications + +View recent DAPB notifications with details of consultation and publication activity, including new Information Standards Notices. + +ARTICLE + +Standards assurance activity + +View a summary of standards assurance activity being presented to upcoming meetings of the Data Alliance Partnership Board (DAPB). + +ARTICLE + +Contact the Data Standards Assurance Service (DSAS) + +Contact DSAS with any queries regarding standards assurance, or sign up to our mailing list to receive notifications with details of consultation and publication activity, including new Information Standards Notices. + +Last edited: 13 October 2022 10:17 pm \ No newline at end of file diff --git a/baselineTexts/clinical-referral-information.txt b/baselineTexts/clinical-referral-information.txt index 3b1792a..d513b67 100644 --- a/baselineTexts/clinical-referral-information.txt +++ b/baselineTexts/clinical-referral-information.txt @@ -26,10 +26,12 @@ Royal College of Speech and Language Therapists Royal College of Surgeons Royal Pharmaceutical Society The standard + Clinical referral information standard Version 1.1 (Dec 17 2019) -The standard has been updated in-line with new PRSB digital medications information assurance. +The standard has been updated in-line with new PRSB digital medications information assurance . + diff --git a/baselineTexts/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems.txt b/baselineTexts/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems.txt index 34da2ce..b163313 100644 --- a/baselineTexts/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems.txt +++ b/baselineTexts/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems.txt @@ -28,7 +28,7 @@ Release title 2018 Update Stage Implementation Key documents Change Specification (Amd 25/2018) -Specification (Amd 25/2018) +Specification (Amd 25/2018) [Archive Content] Implementation Guidance (Amd 25/2018) Information Standards Notice (Amd 25/2018) Guidance - determine the applicability of DCB 0129 and 0160 @@ -75,8 +75,8 @@ Maintenance Key documents -Specification (Amd 38/2012) -Implementation Guidance (Amd 38/2012) +Specification (Amd 38/2012) [Archive Content] +Implementation Guidance (Amd 38/2012) [Archive Content] Information Standards Notice (Amd 38/2012) @@ -87,7 +87,7 @@ Guidance documents Compliance Assessment Template (Amd 38/2012) Agile Development (Amd 38/2012) Middleware (Amd 38/2012) -Telehealth and mobile health solutions (Amd 38/2012) +Telehealth and mobile health solutions (Amd 38/2012) [Archive Content] diff --git a/baselineTexts/commissioning-data-sets-cds.txt b/baselineTexts/commissioning-data-sets-cds.txt new file mode 100644 index 0000000..f1aa926 --- /dev/null +++ b/baselineTexts/commissioning-data-sets-cds.txt @@ -0,0 +1,2046 @@ +Standards and collections + +An alphabetical list of all current approved national information standards and data collections (including extractions). + +Page contents +Top of page +Approved standards and collections +Current standards and collections +How to use the list +Other resources +Approved standards and collections + +This list shows all current Data Alliance Partnership Board (DAPB) approved national information standards and data collections (including extractions) (known as ISCE) for use in health and adult social care.  + +The list is updated on a monthly basis following the approval of new items, and changes, by the DAPB. + +Current standards and collections +Title + +ISCE + +Documentation + + + +Accessible Information + + + +Standard + + + +DCB1605 Guidance (NHS England and NHS Improvement) + + +Adolescent Vaccine Coverage data Collection DAPB0133 Guidance (UK Health Security Agency) + + +Adult Social Care Finance Return + + + +Collection + + + +DCB2135 Guidance (NHS Digital) + + +Adult Social Care Workforce Data Set Collection DCB2143 Guidance (Department of Health and Social Care) +Aggregate Contract Monitoring Standard and a Collection DCB2050 Guidance (NHS England and NHS Improvement)  + + +AIDC for Patient Identification + + + +Standard + + + +DCB1077 Guidance (NHS Digital) + + + + +AIDC: Automatic Identification and Data Capture + + + +Standard + + + +DAPB0108 Guidance (NHS Digital) + + +Alcohol Dependence Programme Patient Level Data Collection Collection DAPB4044 Guidance (NHS Digital) +Ambulance Data Set Collection DAPB3107 Guidance (NHS Digital) + + +Ambulance Electronic Patient Report + + + +Standard + + + +ISB 1516 Guidance + + +Ambulance Services: Computer Aided Dispatch Data Collection DCB3088 documentation + + +Ambulance Quality Indicators - Clinical Outcomes + + + +Collection + + + +DCB3028-01 Guidance (NHS Digital) + + + + +Ambulance Quality Indicators - Systems Indicators + + + +Collection + + + +DCB3028-02 Guidance (NHS Digital) + + +Antibiotic Consumption Data Collection DCB3063 Guidance (NHS England and NHS Improvement) + + +Annual GP Practice electronic Self Declaration (eDEC) + + + +Collection + + + +DCB2053 Guidance (NHS Digital) + + + + +Anonymisation Standard for Publishing Health and Social Care Data + + + +Standard + + + +ISB 1523 Guidance + + + + +Assuring Transformation + + + +Standard and a Collection + + + +DCB2007 Guidance (NHS England and NHS Improvement) + + +Better Care Fund Quarterly Reporting Collection DCB3067 Guidance (NHS England and NHS Improvement) + + +Birth Notifications + + + +Standard + + + +ISB 1555 Guidance + + +Board Vacancies and Commercial Spend Collection DAPB4009 documentation + + +Breast and Cosmetic Implant Registry + + + +Collection + + + +SCCI2132 Guidance (NHS Digital) + + + + +Breast Screening Programme Data Set (KC63 and KC62) + + + +Standard and a Collection + + + +ISB 1597 Guidance + + + + +British Society of Surgery of the Hand (BSSH) Audit + + + +Collection + + + +DCB2196 Guidance (The British Society for Surgery of the Hand (BSSH) Members Area) + + + + +Cancer Outcomes and Services Data set, Version 8.0 + + + +Standard and a Collection + + + +DCB1521 Guidance (Public Health England) + + +Cancer Quality of Life (QoL) Metric survey Collection DCB3102 Guidance (NHS England and NHS Improvement) + + +Cancer Patient Experience Survey + + + +Collection + + + +DCB2116 Guidance (NHS England and NHS Improvement) + + + + +Cancer Patient Tracking List (PTL) + + + +Collection + + + +DAPB3037 Guidance (NHS Digital) + + + + +Cataract Data Set + + + +Standard and a Collection + + + +ISB 0085 Guidance + + + + +CCG Digital Maturity Questionnaire + + + +Collection + + + +DAPB2167 Guidance (NHS Digital) + + + + +Child Protection Information Sharing + + + +Standard + + + +DCB1609 Guidance (NHS Digital) + + + + +Childhood Influenza Vaccination Programme Primary School Age Children + + + +Collection + + + +DCB2195 Guidance (Public Health England) + + + + +Childhood Measurement Central Return + + + +Standard and a Collection + + + +ISB 0146 Guidance + + + + +Children and Young People (CYP) with an Eating Disorder Referral to Treatment Times (RTT) + + + +Collection + + + +SCCI2185 Guidance (NHS Digital) + + + + +Chlamydia Testing Activity Dataset + + + +Standard and a Collection + + + +SCCI1538 Guidance (Public Health England) + + + + +Clinical Risk Management: its Application in the Deployment and Use of Health IT Systems + + + +Standard + + + +DCB0160 Guidance (NHS Digital) + + + + +Clinical Risk Management: its Application in the Manufacture of Health IT Systems + + + +Standard + + + +DCB0129 Guidance (NHS Digital) + + + + +Commissioning Data Sets (CDS) + + + +Standard and a Collection + + + +DAPB0092 Guidance (NHS Digital) + + + + +Commissioning Data Sets (CDS) Version 6.2.3: Emergency Care Data Set (ECDS) + + + +Standard and a Collection + + + +DCB0092-2062 Guidance (NHS Digital) + + +Community Health Staff data collection Collection DCB3095 documentation + + +Community Pharmacy Contractual Framework National Audit + + + +Collection + + + +DCB2103 documentation + + + + +Community Services Data Set + + + +Standard and a Collection + + + +DAPB1069 Guidance (NHS Digital) + + +Compliance with National Data Opt-outs Standard DCB3058 Guidance (NHS Digital) + + +Conflict of Interest Indicator + + + +Collection + + + +DCB2221 Guidance (NHS England and NHS Improvement) + + +Consultant-led Referral to Treatment (RTT) Waiting Times Standard and a Collection DCB0095 Guidance (NHS Digital) +Corporate Services annual data collection Collection DAPB4006 (no guidance published) NHS England and NHS Improvement + + +Cover of Vaccination Evaluated Rapidly (COVER) Return + + + +Standard and a Collection + + + +DAPB0089 Guidance (UKHSA) + + +COVID-19: Bulk capture of COVID-19 vaccinations data collection Collection DAPB4036 (no guidance published) NHS England and NHS Improvement +COVID-19: Community Daily Discharge Situation Report (SitRep) Collection DCB3136 Guidance (NHS Digital) +COVID-19: Community Health Services Situation Report (SitRep) Collection DAPB3132 Guidance (NHS Digital) +COVID-19: Daily Discharge Situation Report (SitRep) Collection DCB3129 Guidance (NHS Digital) +COVID-19: ICU Consumables Stocktake: Renal Stocktake Collection DCB3122 (no guidance published) NHS England and NHS Improvement +COVID-19: Independent Sector Provider (ISP) Weekly Activity Situation Report (SitRep) Collection DCB3139 Guidance (NHS Digital) +COVID-19: Independent Sector Provider (ISP) Diagnostics and Cancer Treatments Daily Situation Report (SitRep) Collection DCB3138 (no guidance published) NHS England and NHS Improvement +COVID-19: Long COVID Assessment Services Data Collection DCB3135 Guidance (NHS Digital) +COVID-19: Maternity COVID Service Alterations Situation Report (SitRep)  Collection DAPB4067 (no guidance published) NHS England and NHS Improvement +COVID-19: NHS Staff Lateral Flow Testing Collection DCB3137 Guidance (NHS Digital) +COVID-19: NHS Weekly Activity Return Collection DCB3142 Guidance (NHS Digital) +COVID-19: Theatre Productivity data collection Collection DAPB4028 documentation + + +CQC provider survey + + + +Collection + + + +DAPB3030 (no guidance published) CQC  + + +CQUIN consolidated data collection Collection DAPB2239 Guidance (NHS England and NHS Improvement) + + +Critical Care Minimum Data Set + + + +Standard and a Collection + + + +ISB 0153 Guidance + + + + +Daily 111 Winter Collection + + + +Collection + + + +DCB3056 Guidance (NHS Digital) + + + + +Database for the National Latent Tuberculosis Screening Programme in New Migrants from High-incidence Countries + + + +Collection + + + +SCCI2108 Guidance (Public Health England) + + + + +Data Security and Protection Toolkit + + + +Standard and a Collection + + + +DAPB0086 Guidance (NHS Digital) + + + + +Delayed Transfers of Care + + + +Collection + + + +DCB3032 Guidance (NHS Digital) + + +Dental Working Patterns Collection DCB3027 Guidance (NHS Digital) + + +Deprivation of Liberty Safeguards (DoLS), under the Mental Capacity Act 2005, Data Collection + + + +Collection + + + +DAPB2101 Guidance (NHS Digital) + + +Devices Patient Level Contract Monitoring Standard and a Collection DCB3002 Guidance (NHS England and NHS Improvement) + + +Diabetic Retinopathy Screening Data Set + + + +Standard and a Collection + + + +ISB 0073 Guidance + + + + +Diagnostic Imaging Data Set + + + +Standard and a Collection + + + +SCCI1577 Guidance (NHS Digital) + + + + +Diagnostics Waiting Times and Activity Monthly Return + + + +Collection + + + +DCB0103-01 Guidance (NHS Digital) + + + + +Dictionary of Medicines and Devices (dm+d) + + + +Standard + + + +SCCI0052 Guidance (NHS Digital) + + + + +Digital Imaging and Communications in Medicine (DICOM) + + + +Standard + + + +ISB 1556 Guidance + + +Digital Maternity Record Standard Standard DCB3066 Guidance (NHS Digital) + + +Direct Access Audiology Priority Treatment List (PTL) and Waiting Times (WT) Dataset + + + +Collection + + + +DCB0127 Guidance (NHS Digital) + + +Drugs Patient Level Contract Monitoring Standard and a Collection DCB2212 Guidance (NHS England and NHS Improvement) +Early Childhood Baseline (DTaP/IPV/Hib+HepB, At-Risk Hepatitis B and Early MMR) Extraction DAPB4046 (no guidance published) UKHSA + + +EDIFACT Pathology Messaging + + + +Standard + + + +ISB 1557 Guidance + + + + +Electronic Yellow Card Reporting, Version 3.0 + + + +Standard + + + +DCB1582 Guidance (Medicines and Healthcare products Regulatory Agency (MHRA)) + + + + +eMED3 (fit notes) + + + +Collection + + + +SCCI2118 Guidance (NHS Digital) + + + + +Estates Return information Collection (ERIC) + + + +Collection + + + +DAPB2083 Guidance (NHS Digital) + + + + +Female Genital Mutilation Enhanced Dataset + + + +Standard and a Collection + + + +SCCI2026 Guidance (NHS Digital) + + +FFP3 resilience data collection Collection DAPB4055 (no guidance published) Department of Health and Social Care + + +FGM - Information Sharing (FGM-IS) Local System Integration + + + +Standard + + + +DCB2112 Guidance (NHS Digital) + + + + +Fill Rate Indicator Return, Staffing, Nursing, Midwifery, Allied Health Professional and Care Staff + + + +Collection + + + +DCB2039 Guidance (NHS Digital) + + +Fleet data for Model Ambulance Collection DAPB4035 (no guidance published) NHS England and NHS Improvement) + + +Friends and Family Test + + + +Collection + + + +DCB2054 Guidance (NHS Digital) + + +Friends and Family Test: Post-COVID Assessment Clinics Collection DAPB2054-4026 Guidance (NHS England and NHS Improvement) +Friends and Family Test: Quarterly Staff Survey (National Quarterly Pulse Survey (NQPS))  Collection DAPB2054-3144 Guidance (NHS Digital) +General Practice and Primary Care Network Workforce Collection DAPB4034 (no guidance published) Department of Health and Social Care +General Practice (including Dental) Complaints (KO41b) Collection DAPB2126 Guidance (NHS Digital) +General Practice Pay Transparency Collection DAPB4023 Guidance (NHS England and NHS Improvement) + + +Genetic Testing Rates + + + +Collection + + + +SCCI2035 Guidance (NHS Digital) + + + + +GP Appointments + + + +Collection + + + +DCB3018 Guidance (NHS Digital) + + + + +GP Workload Tool + + + +Collection + + + +DAPB2236 Guidance (NHS Digital) + + +GPES: 6-in-1 vaccination programme Extraction DCB2090-3141 Guidance (NHS Digital) +GPES: Cardiovascular Disease Prevention Audit +(CVDPREVENT) Extraction DCB2090-3109 documentation + + +GPES: Childhood Seasonal Influenza Vaccination Programme + + + +Extraction + + + +DAPB2090-2206 Guidance (NHS Digital) + + + + +GPES: Core Contract + + + +Extraction + + + +DAPB2090-3010 Guidance (NHS Digital) + + +GPES: COVID-19 At Risk Patients data collection Extraction DCB2090-3114 Guidance (NHS Digital) + + +GPES: Indicators no longer in the Quality and Outcomes Framework (QOF) + + + +Extraction + + + +DAPB2090-2232 Guidance (NHS Digital) + + +GPES: Learning Disabilities Data Extraction DAPB2090-2171 Guidance (NHS Digital) + + +GPES: Learning disabilities health check scheme + + + +Extraction + + + +DAPB2090-2191 Guidance (NHS Digital) + + + + +GPES: Meningococcal ACWY Vaccination Programme + + + +Extraction + + + +DAPB2090-2133 Guidance (NHS Digital) + + + + +GPES: Meningococcal B Vaccination Programme + + + +Extraction + + + +DAPB2090-2187 Guidance (NHS Digital) + + +GPES: Network Contract Directed Enhanced Services (DES)    Extraction DAPB2090-3084 Guidance (NHS Digital) +GPES: PCV HIB MenC Vaccination Programme Extraction DAPB2090-2225 Guidance (NHS Digital) + + +GPES: Pertussis in pregnant women vaccination programme + + + +Extraction + + + +DCB2090-2180 Guidance (NHS Digital) + + +GPES: Physical Health Checks for People with Serious Mental Illness Extraction DCB2090-3038 Guidance (NHS Digital) + + +GPES: Pneumococcal polysaccharide vaccination programme + + + +Extraction + + + +DAPB2090-2181 Guidance (NHS Digital) + + + + +GPES: Quality and Outcomes Framework (QOF) + + + +Extraction + + + +DAPB2090-2183 Guidance (NHS Digital) + + + + +GPES: Rotavirus (routine childhood immunisation) Vaccination Programme + + + +Extraction + + + +DAPB2090-2182 Guidance (NHS Digital) + + + + +GPES: Seasonal Influenza Vaccination Programme + + + +Extraction + + + +DAPB2090-2207 Guidance (NHS Digital) + + + + +GPES: Shingles Combined Vaccination Programme + + + +Extraction + + + +DAPB2090-2208 Guidance (NHS Digital) + + +Greener NHS - Fleet data collection Collection DAPB4058 Guidance (NHS England and NHS Improvement) (login required) +Greener NHS quarterly data collection Collection DAPB4062 (no guidance published) NHS England and NHS Improvement + + +GUMCAD STI Surveillance System + + + +Standard and a collection + + + +DCB0139 Guidance (Public Health England) + + + + +HA/GP Links + + + +Standard + + + +ISB 1558 Guidance + + + + +Health and Social Care Organisation Reference Data + + + +Standard + + + +DAPB0090 Guidance (NHS Digital) + + + + +Healthcare Resource Groups (HRG) + + + +Standard + + + +ISB 0070 Guidance + + + + +Healthy Child Programme  + + + +Standard  + + + +DAPB3009 Guidance (NHS Digital) + + + + +Hepatitis B (new born) Babies Vaccination Programme (CQRS) + + + +Extraction + + + +DCB2090-2178 Guidance (NHS Digital) + + + + +HIV and AIDs Reporting System (HARS) + + + +Standard and a Collection + + + +SCCI1570 Guidance (Public Health England) + + + + +Hospital and Community Health Services Written Complaints Collection (KO41a) + + + +Collection + + + +SCCI2125 Guidance (NHS Digital) + + + + +HPV Booster Vaccination Programme (CQRS) + + + +Collection + + + +DCB2176 Guidance (NHS Digital) + + + + +Identity Verification and Authentication Standard for Digital Health and Care Services + + + +Standard + + + +DCB3051 Guidance (NHS Digital) + + + + +Improving Access to Psychological Therapies Data Set + + + +Standard and a Collection + + + +DAPB1520 Guidance (NHS Digital) + + +Influenza and COVID-19 vaccine uptake in Frontline Healthcare Workers (HCWs) survey Collection DAPB2204 Guidance (Public Health England) + + +Information Governance Standards Framework + + + +Standard + + + +ISB 1512 Guidance + + + + +ISB 1594 Guidance + + + + +Integrated Urgent Care Aggregate Data Collection + + + +Collection + + + +DAPB3031 Guidance (NHS Digital) + + +Integrated Urgent Care Forecasting and Capacity Planning Collection DCB3076 documentation +Integrating Flu/ COVID Hospitalisation Surveillance Collection DCB2043 (no guidance published)  + + +Interim Clinical Imaging Procedure Codes + + + +Standard + + + +ISB 0148 Guidance + + + + +International Statistical Classification of Diseases and Related Health Problems (ICD-10) + + + +Standard + + + +SCCI0021 Guidance (NHS Digital) + + + + +Inter-Provider Transfer Administrative Minimum Data Set + + + +Standard + + + +ISB 0112 Guidance + + + + +Junior Doctors – Rota Notification + + + +Collection + + + +DCB3042 Guidance (NHS Digital) + + + + +KH03: Bed Availability and Occupancy + + + +Collection + + + +DCB1576 Guidance (NHS Digital) + + +Legal Services Target Operating Model (LSTOM) data collection Collection DAPB4007 (no guidance published) NHS England and NHS Improvement +Long Length of Stay Discharge Patient Tracking List Collection DCB3079 Guidance (NHS Digital) + + +Maternity Services Data Set + + + +Standard and a Collection + + + +DCB1513 Guidance (NHS Digital) + + +Measles, Mumps and Rubella (MMR) vaccine coverage collection Extraction DAPB4049 (no guidance published) UKHSA + + +Measles, Mumps, Rubella (MMR) Vaccination Programme (CQRS) + + + +Collection + + + +DAPB2179 Guidance (NHS Digital) + + +Medical Revalidation Annual Organisational Audit Collection DCB3077 Guidance (NHS England and NHS Improvement) +Medication in Children and Young People Inpatient Audit Collection DAPB4056 (no guidance published) NHS England and NHS Improvement +Medicine and Allergy/Intolerance Data Transfer Standard DAPB4013 Guidance (NHS Digital) +Meningococcal ACWY (MenACWY) vaccine coverage vaccine coverage collection Extraction DAPB4047 (no guidance published) UKHSA +Meningococcal B (MenB) vaccine coverage vaccine coverage collection Extraction DAPB4048 (no guidance published) UKHSA + + +Mental Health Services Data Set + + + +Standard and a Collection + + + +DCB0011 Guidance (NHS Digital) + + +Mental Health Staff data collection Collection DCB3089 documentation + + +Mixed-Sex Accommodation + + + +Collection + + + +DCB1573 Guidance (NHS Digital) + + +Model Health System procurement metrics Collection DAPB4061 (no guidance published ) NHS England and NHS Improvement + + +Monthly Referral Return + + + +Collection + + + +DCB3023-01 Guidance (NHS England and NHS Improvement) + + + + +Monthly Situation Report – Critical Care and Urgent Cancelled Operations + + + +Collection + + + +DCB3025 Guidance (NHS Digital) + + + + +Monthly Situation Report – Emergency Care + + + +Collection + + + +DCB1607 Guidance (NHS Digital) + + + + +National Cancer Waiting Times Monitoring Data Set + + + +Standard and a Collection + + + +DCB0147 Guidance (NHS Digital) + + +National COVID-19 Chest Imaging Database (NCCID) Collection DAPB4032 Guidance (NHSX) + + +National Diabetes Audit + + + +Collection + + + +DCB2235-01 Guidance (NHS Digital) + + + + +National Diabetes Footcare Audit + + + +Collection + + + +DCB2235-03 Guidance (NHS Digital) + + +National Diabetes Inpatient Safety Audit (NDISA) + +Collection + + + +DCB2235-05 Guidance (NHS Digital)  + + + + +National Drug and Alcohol Treatment Monitoring System (NDTMS) Data Set + + + +Standard and a Collection + + + +DAPB0107 Guidance (Public Health England) + + + + +National Joint Registry Data Set + + + +Standard and a Collection + + + +DCB1567 Guidance (National Joint Registry (NJR)) + + + + +National Pregnancy in Diabetes Audit + + + +Collection + + + +DCB2235-02 Guidance (NHS Digital) + + +National Waiting List Weekly Minimum Data Set Collection DCB3145 documentation +National Wheelchair Data Collection Collection DCB2097 Guidance (NHS Digital) + + +National Workforce Data Set + + + +Standard + + + +DAPB1067 Guidance (NHS Digital) + + + + +Neonatal Critical Care Minimum Data Set + + + +Standard and a Collection + + + +SCCI0075 Guidance (NHS Digital) + + + + +Neonatal Data Set + + + +Standard and a Collection + + + +DAPB1595 Guidance (Imperial College London) + + +NHS Continuing Healthcare (CHC) Deferred Assessments SitRep Collection DCB3127 Guidance (NHS Digital) +NHS Continuing Healthcare (CHC) Patient-Level Data Set Standard and a Collection DCB3085 Guidance (NHS Digital) + + +NHS Continuing Healthcare quarterly collection + + + +Collection + + + +DCB2117 Guidance (NHS Digital) + + + + +NHS 111 Pathways + + + +Collection + + + +DCB2228 documentation + + + + +NHS 111 Patient Experience Survey + + + +Collection + + + +DAPB3029 Guidance (NHS Digital) + + +NHS Health Care Worker (HCW) CCG COVID-19 vaccination uptake SitRep Collection DAPB3146-01 documentation +NHS Health Care Worker (HCW) Trust COVID-19 vaccination uptake SitRep Collection DAPB3146-02 documentation + + +NHS Health Check + + + +Standard and a Collection + + + +ISB 1080 Guidance + + + + +NHS Number + + + +Standard + + + +ISB 0149 Guidance + + + + +NHS Number for General Practice + + + +Standard + + + +ISB 0149-01 Guidance + + + + +NHS Number for Secondary Care + + + +Standard + + + +ISB 0149-02 Guidance + + +NHS Premises Assurance Model online system Collection DAPB4021 Guidance (NHS England and NHS Improvement) +NHS Staff Survey Collection DAPB3078 Guidance (NHS England and NHS Improvement) +NHS Surplus Land Collection DCB2154 Guidance (NHS Digital) +NHS Trust and CCG Governing Bodies - 2020 Board Membership and Diversity Survey (England) Collection DCB3133 documentation +Non-Emergency Patient Transport Services Data Set Collection DAPB4030 (no guidance published) NHS England and NHS Improvement +Online and Video Consultation in General Practices Collection DAPB4031 Guidance (NHS Digital) + + +OPCS Classification of Interventions and Procedures + + + +Standard + + + +DCB0084 Guidance (NHS Digital) + + + + +Out of Area Placements (OAPs) + + + +Collection + + + +SCCI2213 Guidance (NHS Digital) + + + + +Overseas Visitor Charging Category (OVCC) + + + +Standard + + + +DCB3017 Guidance (NHS Digital) + + + + +Paediatric Critical Care Minimum Data Set + + + +Standard and a Collection + + + +SCCI0076 Guidance (NHS Digital) + + + + +Palliative Care Co-ordination: Core Content + + + +Standard + + + +SCCI1580 Guidance (Public Health England) + + +Pathology Test and Results Standard Standard DAPB4017 Guidance (NHS Digital) + + +Patient Identifiers for Identity Bands + + + +Standard + + + +ISB 0099 Guidance + + + + +Patient-Led Assessments of the Care Environment (PLACE) + + + +Collection + + + +DAPB2085 Guidance (NHS Digital) + + +Patient Level Contract Monitoring Standard and a Collection DCB3003 Guidance (NHS England and NHS Improvement) +Patient Level Information and Costing Systems (PLICS) Integrated Data Set Standard and a Collection DAPB4000 Guidance (NHS England and NHS Improvement) +Patient-Level Information and Costing Systems (PLICS) Ambulance Data Set Standard and a Collection DAPB4001 Guidance (NHS England and NHS Improvement) + + +Personal Health Budgets + + + +Collection + + + +DCB2184 Guidance (NHS Digital) + + +Personal Social Services Adult Social Care Survey, England Collection DAPB2153 Guidance (NHS Digital)  + + +Personal Social Services Survey of Adult Carers in England + + + +Collection + + + +DAPB2169 Guidance (NHS Digital) + + +Personalised Care and Support Plan Standard DAPB4022 Guidance (Professional Record Standards Body (PRSB)) + + +Physical healthcare for people with serious mental illness (SMI): Primary care data collection + + + +Collection + + + +DCB3038 Guidance (NHS Digital) + + +Physiological Measurements Services data collection Collection DAPB4043 (no guidance published) NHS England and NHS Improvement +Plastics Reduction Pledge Collection DCB3091 Guidance (NHS England and NHS Improvement)  +Pneumococcal Polysaccharide Vaccine (PPV) vaccine coverage collection Extraction DAPB4050 (no guidance published) UKHSA +Post-COVID Assessment Clinic Patient List Collection DAPB4027 Guidance (NHS England and NHS Improvement) (login required) +Prenatal Pertussis vaccine coverage collection Extraction DAPB4037 (no guidance published) UKHSA + + +Prevent Training Reports + + + +Collection + + + +SCCI2193 Guidance (NHS Digital)  + + + + +Primary care Commissioning Activity Report (PCAR) + + + +Collection + + + +DCB2197 Guidance (NHS Digital) + + +Primary Care Monitoring Survey Collection DAPB3128 Guidance NHS England and NHS Improvement (login required) + + +Programme Budgeting + + + +Collection + + + +DCB3007 documentation + + +Provider Elective Recovery Outpatient Collection (Provider EROC) Collection DAPB4033 Guidance (NHS England and NHS Improvement) (login required) +Public Health Specialist Workforce data collection Collection DCB3082 documentation +Public Sector Apprenticeship Target: Statutory annual reporting Collection DCB3071 Guidance (Department for Education) + + +Quarterly Monitoring Cancelled Operations + + + +Collection + + + +DCB0143 Guidance (NHS Digital) + + + + +Radiotherapy Data Set + + + +Standard and a Collection + + + +DAPB0111 Guidance (Public Health England) + + +Referral to Treatment (RTT) Weekly Patient Tracking List (PTL) Collection + +DCB3090 documentation + + +Rotavirus vaccine coverage collection Extraction DAPB4051 (no guidance published) UKHSA + + +Safeguarding Adults Collection (SAC) + + + +Collection + + + +DCB2172 Guidance (NHS Digital) + + +Safeguarding Case Review Tracker Collection DCB3124 documentation +Seasonal Influenza Vaccine Uptake (GP Patient) Survey (Main) + +Collection + + + +DCB2205 Guidance (Public Health England) + + +Seasonal Influenza Vaccine Uptake (GP Patient) Survey (Child) + +Collection + + + +DCB2211 Guidance (Public Health England) + + + + +Secure Email + + + +Standard + + + +DCB1596 Guidance (NHS Digital) + + + + +Seven Day Services Survey + + + +Collection + + + +SCCI2173 documentation + + + + +Sexual and Reproductive Health Activity Dataset + + + +Standard and a Collection + + + +SCCI1518 Guidance (Public Health England) + + + + +Sexual Orientation Monitoring + + + +Standard + + + +DCB2094 Guidance (NHS England and NHS Improvement) + + +Shingles annual vaccine coverage collection Extraction DAPB4053 (no guidance published) UKHSA +Shingles quarterly vaccine coverage collection Extraction DAPB4052 (no guidance published) UKHSA +Shingles Shingrix quarterly vaccine coverage collection Extraction DAPB4054 (no guidance published) UKHSA + + +Short and Long Term Return (SALT) + + + +Collection + + + +DAPB2161 Guidance (NHS Digital) + + + + +SNOMED CT + + + +Standard + + + +SCCI0034 Guidance (NHS Digital) + + + + +Specialised Services National Definitions Set + + + +Standard + + + +ISB 0005 Guidance + + +Spend Comparison: Accounts Payable data  Collection DCB3080-02 Guidance (NHS Digital) +Spend Comparison: Purchase Order data Collection DCB3080-01 Guidance (NHS Digital) +Staff Networks Maturity Framework Collection DAPB4040 (no guidance published) NHS England and NHS Improvement + + +Stop Smoking Service Quarterly Monitoring Return + + + +Collection + + + +DCB0155 Guidance (NHS Digital) + + +Sugar Sweetened Beverages collection Collection DCB3099 documentation +Surgical Devices and Implants Core Data Set Standard and a Collection DAPB3103 Guidance (NHS Digital) +Surgical Devices and Implants, Phase 1: Pelvic Floor Registry Collection DCB3103-01 Guidance (NHS Digital) + + +Surveillance of Healthcare Associated Infections + + + +Standard and a Collection + + + +DCB0134 Guidance (Public Health England) + + +System Elective Recovery Outpatient Collection (System EROC) Collection DAPB4039 Guidance (NHS England and NHS Improvement) (login required) + + +Systemic Anti-Cancer Therapy Data Set + + + +Standard and a Collection + + + +DCB1533 Guidance (Public Health England) + + +Tobacco Dependence Programme Patient Level Data Collection Collection DAPB4041 Guidance (NHS Digital) +Transfer of Care - Acute Inpatient Discharge  Standard DAPB4042 Guidance (NHS Digital) + + +Trauma Audit and Research Network Notification Data Set + + + +Standard and a Collection + + + +ISB 1606 Guidance + + +Treatment Function and Main Specialty Standard Standard DCB0028 Guidance (NHS Digital) +Under 16 Cancer Patient Experience Survey 2020-23 Collection DCB3131 Guidance (NHS England and NHS Improvement) +UK Core Fast Healthcare Interoperability Resources (FHIR) Release 4 (R4) Governance Standard DAPB4020 Guidance (NHS Digital) +Urgent and Emergency Mental Health Care and Intensive Home Treatment for Children and Young People – Third National Survey Collection DCB3093 documentation + + +Venous Thromboembolism (VTE) Risk Assessment + + + +Collection + + + +DCB1593 Guidance (NHS Digital) + + +Violence Against Staff Collection DCB3100 (no guidance published) NHS England and NHS Improvement +Virtual Wards data collection Collection DAPB4068 Guidance (NHS England and NHS Improvement) (login required) +Volunteer numbers supporting NHS Trusts Survey Collection DAPB4057 (no guidance published) NHS England and NHS Improvement + + +Weekly Diagnostic Activity Collection + + + +Collection + + + +SCCI2163 Guidance (NHS England and NHS Improvement) + + + + +Workforce Disability Equality Standard (WDES) + + + +Collection + + + +DAPB3048 Guidance (NHS England and NHS Improvement) + + + + +Workforce Race Equality Standard (WRES) + + + +Collection + + + +DAPB3040 Guidance (NHS Digital) + +How to use the list + +For each item you can see: + +title - the name of the standard or collection +ISCE - shows whether this is a standard or a collection +documentation - the reference number for the ISCE (a unique identifier with a prefix indicating who approved it) with a link to published guidance for the ISCE (where available) +Approvals and acceptance +Prefix Approved or accepted by +DAPB Data Alliance Partnership Board +DCB Data Coordination Board (legacy) +ISB Information Standards Board (legacy) +SCCI Standardisation committee for care information (legacy) +ISCE values +Value + +Meaning + +Standard an information standard +Standard and collection an information standard which incorporates a collection +Standard and an extraction an information standard which incorporates a data extraction +Collection a data collection +Extraction a data extraction +  +Other resources +ARTICLE + +Information Standards Notices + +Information Standards Notices (ISNs) are published to announce new or changes to information standards published under section 250 of the Health and Social Care Act 2012. + +ARTICLE + +Withdrawn standards and collections + +A list of withdrawn and deprecated information standards and collections. + +ARTICLE + +Publications and notifications + +View recent DAPB notifications with details of consultation and publication activity, including new Information Standards Notices. + +ARTICLE + +Standards assurance activity + +View a summary of standards assurance activity being presented to upcoming meetings of the Data Alliance Partnership Board (DAPB). + +ARTICLE + +Contact the Data Standards Assurance Service (DSAS) + +Contact DSAS with any queries regarding standards assurance, or sign up to our mailing list to receive notifications with details of consultation and publication activity, including new Information Standards Notices. + +Last edited: 13 October 2022 10:17 pm \ No newline at end of file diff --git a/baselineTexts/commissioning-data-sets-emergency-care-data-set.txt b/baselineTexts/commissioning-data-sets-emergency-care-data-set.txt new file mode 100644 index 0000000..7fa469c --- /dev/null +++ b/baselineTexts/commissioning-data-sets-emergency-care-data-set.txt @@ -0,0 +1,90 @@ +DCB0092-2062 : Commissioning Data Sets: Emergency Care Data Set + +Type 011: Emergency Care Data Set (ECDS) is the Commissioning Data Set (CDS) Type for emergency care services. + +Page contents +Top of page +About this information standard +Current release +Previous releases +Updates +About this information standard + +The Emergency Care Data Set (ECDS) enables the capture of information about: + +the complexity and acuity of attending patients +the causes of rising demand +the value added by emergency departments. + +It also allows for: + +the capture of diagnostic data to ensure an enhanced understanding of need, activity and outcomes +consistent monitoring of data across local and national initiatives +support for injury surveillance, such that it will be possible to identify patterns that may be amenable to targeted interventions and improved public health. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Release date 10/09/2020 +Release number Amd 19/2020 +Release title CDS Version 6.2.3 Type 011 +Stage  Implementation +Key documents  +Information Standards Notice (Amd 19/2020) +Requirements Specification (Amd 19/2020)  +Change Specification (Amd 19/2020) +Implementation Guidance (Amd 19/2020) +Technical Output Specification v1.2 (Amd 19/2020) (February 2022) [Archive Content] + +Supporting documents +User Guidance +NHS Data Model and Dictionary Change Request 1740 +NHS Data Model and Dictionary Change Request 1740 (data set) +XML Schema (external site, registration required) + +Note ISB 0092 is the overarching information standard for the Commissioning Data Sets, refer to this for submission of existing CDS types.  +Previous releases +CDS Version 6.2.2 Type 011 +Release date 07/11/2018 +Release number Amd 34/2018 +Stage  Maintenance +Key documents  +Requirements Specification (Amd 34/2018)  +Change Specification (Amd 34/2018) +Implementation Guidance (Amd 34/2018) +Information Standards Notice (Amd 34/2018) +Technical Output Specification v2.1 (March 2019) [Archive Content] +Corrigendum (March 2019) + +Supporting documents +NHS Data Model and Dictionary Change Request 1654 +NHS Data Model and Dictionary Change Request 1654 (data set) +NHS Data Model and Dictionary Change Request 1715 (March 2019) +  +Version 6.2.1: Addition of Type 011: Emergency Care Data Set (ECDS) + +Release date + + 19/04/2017 +Release number Amd 17/2015 +Stage Retirement +Key documents +Requirements Specification (Amd 17/2015) [Archive Content] +Change Specification (Amd 17/2015) [Archive Content] +Implementation Guidance (Amd 17/2015) [Archive Content] +Information Standards Notice (Amd 17/2015) [Archive Content] +Technical Output Specification v1.01 (Amd 17/2015) [Archive Content] +Corrigendum (October 2017) +Corrigendum (March 2019) + +Supporting documents +NHS Data Model and Dictionary Change Request 1598 (Amd 17/2015) +NHS Data Model and Dictionary Change Request Data Set 1598 (Amd 17/2015) +NHS Data Model and Dictionary Change Request 1717 (March 2019) +Updates + +Update 2 March 2022: Publication of updated Technical Output Specification (TOS) in respect of CDS Version 6.2.3 Type 011 (Amd 19/2020).  Editorial corrections to the TOS have been made, information about the changes can be found in the Change Control tab of the TOS (uplifted to document version 1.2 February 2022).  + +Update 26 January 2022: Publication of updated Technical Output Specification (TOS) in respect of CDS Version 6.2.3 Type 011 (Amd 19/2020).  Editorial corrections to the TOS have been made, information about the changes can be found in the Change Control tab of the TOS (uplifted to document version 1.1 January 2022).  + +Last edited: 2 March 2022 1:41 pm \ No newline at end of file diff --git a/baselineTexts/community-services-data-set.txt b/baselineTexts/community-services-data-set.txt new file mode 100644 index 0000000..e148e8e --- /dev/null +++ b/baselineTexts/community-services-data-set.txt @@ -0,0 +1,69 @@ +DAPB1069: Community Services Data Set + +The Community Services Data Set (CSDS) is a patient level, output based, secondary uses data about publicly funded Community Services. + +Page contents +Top of page +About this information standard +Current releases +Updates +About this information standard + +The Community Services Data Set (CSDS) is a patient level, output based, secondary uses data set which will deliver robust, comprehensive, nationally consistent and comparable person centred information for people who are in contact with publicly funded Community Services. + +The standard defines the data items, definitions and associated value sets to be extracted or derived from local systems, and submitted to NHS Digital on a monthly basis. Note that this data set does not specify the data to be captured for direct patient care, but will make use of such clinical and operational data for secondary uses. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current releases +Version 1.6 +Release date 06/01/2022 +Release number Amd 82/2021 +Stage Implementation +Key documents +Requirements Specification (Amd 82/2021) (May 2022) +Change Specification (Amd 82/2021) (May 2022) +Implementation Guidance (Amd 82/2021) (May 2022) [Archive Content] +Technical Output Specification (Amd 82/2021) +Information Standards Notice (Amd 82/2021) (May 2022) + +Supporting documents +NHS Data Model and Dictionary Change Request - 1844  (Basic CR) (Amd 82/2021) (May 2022) +NHS Data Model and Dictionary Change Request - 1844 (Data Set CR) (Amd 82/2021) (May 2022) +XML Schema (Amd 82/2021) (external site; login required).  + +Further information + +More information, including the Enhanced Technical Output Specification, can be found on the NHS Digital CSDS web pages  + +  + +  + +Version 1.5 +Release date 16/10/2019 +Release number Amd 95/2018 +Stage Maintenance +Key documents +Requirements Specification (Amd 95/2018) +Change Specification (Amd 95/2018) +Implementation Guidance (Amd 95/2018) [Archive Content] +Technical Output Specification (Amd 95/2018) +Information Standards Notice (Amd 95/2018) + +Supporting documents +NHS Data Model and Dictionary Change Request - 1690 (Basic CR) (Amd 95/2018) +NHS Data Model and Dictionary Change Request - 1690 (Data Set CR) (Amd 95/2018) +XML Schema (Amd 95/2018) (external site; login required) + +Documentation from previous releases are available on request from standards.assurance@nhs.net  + +  + +Updates + +12 May 2022:  At the time of publication of version 1.6 (6 January 2022), users were expected to fully conform with this standard by 14 September 2022. Due to resource pressures that have built up at NHS Digital over 2021-22, NHS Digital has since extended the implementation and conformance dates of this standard by six months. Full conformance is now expected with the submission of the January 2023 reporting activity by 14 March 2023. + +The Requirements Specification, Change Specification, Implementation Guidance and Information Standards Notice have been annotated to reflect this, and updated NHS Data Model and Dictionary Change Requests have been published.  The updated copies of the documents are available in the version 1.6 release table above. + +Last edited: 12 May 2022 10:32 am \ No newline at end of file diff --git a/baselineTexts/consultant-led-referral-to-treatment-waiting-times.txt b/baselineTexts/consultant-led-referral-to-treatment-waiting-times.txt new file mode 100644 index 0000000..57184bc --- /dev/null +++ b/baselineTexts/consultant-led-referral-to-treatment-waiting-times.txt @@ -0,0 +1,53 @@ +DCB0095: Consultant-led referral to treatment (RTT) waiting times + +Monthly aggregate data collection to monitor consultant-led referral to treatment (RTT) waiting times + +Page contents +Top of page +About this information standard +Current release +Previous releases +About this information standard + +In England, under the NHS Constitution, patients have ‘the right to access certain services commissioned by NHS bodies within maximum waiting times’.  This information standard outlines the specification and requirements for an aggregate monthly data collection to monitor waiting times performance against the standards set out in the National Health Service Commissioning Board and Clinical Commissioning Groups (Responsibilities and Standing Rules) Regulations 2012, and the 2015 amendment. + +Data are submitted to NHS England and NHS Improvement via NHS Digital’s Strategic Data Collection Service (SDCS) and form the basis of National Statistics for Consultant-led Referral to Treatment Waiting Times published by NHS England and NHS Improvement. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the Specification and Implementation Guidance document provides further detail for those who have to implement the information standard. + +Current release +Release date 11 March 2021 +Release number Amd 2/2020 +Release title Version 2.0 +Stage Implementation +Key documents +Information Standards Notice (Amd 2/2020) +Requirements Specification and Implementation Guidance (Amd 2/2020) + +Supporting documents +DSCN 44/2007 Data Standards; Inter-Provider Transfer Administrative Minimum Data set +DSCN 07/2008 Data Standards: Inter-Provider Transfer Administrative Minimum Data Set (IPTAMDS) +DSCN 16/2009 Commissioning Data Sets: Mandation of 18 Week Referral To Treatment Data Items + + + +Further information + + + +More information about the RTT Rules is available on the NHS England and NHS Improvement website. + +Information about submitting DCB0095 data to the Strategic Data Collection Service is available on the NHS Digital website.  + +  + +Previous releases +Release date 04/08/2006 +Release number DSCN 17/2006 +Stage Superseded by DCB0095 Amd 2/2020 +Key documents +DSCN 17/2006  Introduction of new data collection to monitor referral to treatment (RTT) times to support delivery of 18 weeks  + +  + +Last edited: 18 August 2021 8:12 am \ No newline at end of file diff --git a/baselineTexts/core-information-standard.txt b/baselineTexts/core-information-standard.txt index 59e9e24..7fe0ace 100644 --- a/baselineTexts/core-information-standard.txt +++ b/baselineTexts/core-information-standard.txt @@ -1,19 +1,27 @@ -Core information standard v2.0 +Core information standard -The Core information standard defines a set of information that can potentially be shared between systems in different sites and settings, among professionals and people using services. Version 1.0 of the standard was produced following consultation with more than 1,500 individuals and organisations through online and face-to-face workshops and a survey.  +The core information standard defines a set of information that can potentially be shared between systems in different sites and settings, among professionals and people using services. Version 1.0 of the standard was produced following consultation with more than 1,500 individuals and organisations through online and face-to-face workshops and a survey.  + +In January 2021, PRSB was commissioned by NHSX to update the core information standard from a conceptual information model to a logical model. -In January 2021, PRSB was commissioned by NHSX to update the Core information standard from a conceptual information model to a logical model. What is new in V2.0? -The updated Core information standard includes; +The updated core information standard includes; A new logical model that will enable consistency of clinical content, data types, value sets and semantic messages A clinical relationship model that links relationships within sections and elements of the standard, this can be used by implementers to develop physical models. -Aligns with many other published PRSB standards including Maternity, Healthy child and the Community pharmacy standard. -Updates from the Social care programme including more detail of the services being provided to a person such as equipment and adaptions as well as vital About me content – the information a person wants to share with health and care professionals. +Aligns with many other published PRSB standards including maternity, healthy child and the community pharmacy standard. +Updates from the social care programme including more detail of the services being provided to a person such as equipment and adaptions as well as vital About me content – the information a person wants to share with health and care professionals. Alignment with FHIR. We are working closely with the NHS Digital interoperability team to align V2.0 to the UK core R4 FHIR profiles. This is in progress and with work completed on many areas such as person demographics, allergies and adverse reactions, medications and medical devices. -  + +Using the standard in five community settings: pharmacy, optometry, dentistry, ambulance and community services + +PRSB has extended the use of the core information standard for shared care records to professionals working in pharmacy, optometry, dentistry, ambulance and community services, following widespread consultation with clinicians, people using these services and a range of PRSB stakeholders. + +This will ensure that professionals working in these care settings have access to the right information at the right time to provide clinically safe and effective care, subject to appropriate information governance controls. Using the standard in these settings should improve care and outcomes for people, and it should improve the working lives of professionals who won’t need to create workarounds or log into multiple systems to ensure they have a complete picture of a person’s current and relevant care history, before starting treatment. + + Endorsement The core information standard V1 is endorsed by the following organisations: @@ -42,24 +50,21 @@ Royal College of Pathologists Royal College of Physicians Royal College of Speech and Language Therapists Royal College of Surgeons - -Renewed endorsement is in progress for v2.0 and will be published here once available. - -Core information standard v2.0 +View the Core information standard Supporting documentation -Core information standard V2.0 logical model -Core information standard implementation guidance V2.0 -Release notes V2.0 +Core information standard use in five community settings + Clinical safety case report – publishing soon Core information standard V1 documentation -Core information standard V1 -Final report V1 -Survey results V1 -Implementation guidance -Clinical safety case report V1 -Hazard log V1 IHRIM record correction guidance Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. -VIEW THE GUIDANCE \ No newline at end of file +VIEW THE GUIDANCE +Orion Health first to become conformant against the Core Information Standard + +Orion Health has been awarded the PRSB Quality Mark for conformance with the core information standard – the first supplier to achieve this watershed on the journey to interoperable shared care records. + +  + +READ MORE \ No newline at end of file diff --git a/baselineTexts/cover-of-vaccination-evaluated-rapidly.txt b/baselineTexts/cover-of-vaccination-evaluated-rapidly.txt new file mode 100644 index 0000000..81d069f --- /dev/null +++ b/baselineTexts/cover-of-vaccination-evaluated-rapidly.txt @@ -0,0 +1,55 @@ +DAPB0089: Cover of Vaccination Evaluated Rapidly (COVER) + +The COVER (Cover of Vaccination Evaluated Rapidly) surveillance scheme evaluates the childhood immunisation programme in England + +Page contents +Top of page +About this information standard +Current releases +About this information standard + +The COVER (Cover of Vaccination Evaluated Rapidly) surveillance scheme evaluates the childhood immunisation programme in England, for children aged one, two and five years of age. General Practice and local authority level vaccine coverage data is submitted quarterly and annually to the NHS Digital Strategic Data Collection Service (SDCS).  + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standard. + +Current releases +Version 2.3 +Release date 6 January 2022  +Release number Amd 80/2021 +Stage Implementation +Key documents +Change Specification (Amd 80/2021) +Specification (Amd 80/2021) +Appendix 1 (Amd 80/2021) +Implementation Guidance (Amd 80/2021) +Information Standards Notice (Amd 80/2021) + +Supporting documents +NHS Data Model and Dictionary Change Request 1847 (Basic CR) (Amd 80/2021) +NHS Data Model and Dictionary Change Request 1847 (Data Set CR) (Amd 80/2021) + +Further information + +Further guidance is published by: + +the UK Health Security Agency (UKHSA) and +the Strategic Data Collections Service (SDCS) at NHS Digital + +  + +Version 2.2 +Release date 6 February 2020 +Release number Amd 60/2019 +Stage Maintenance +Key documents +Specification (Amd 60/2019) [Archive Content] +Implementation Guidance (Amd 60/2019) [Archive Content] +Information Standards Notice (Amd 60/2019) + +Supporting documents +NHS Data Model and Dictionary Change Request 1753 (Basic CR) (Amd 60/2019) +NHS Data Model and Dictionary Change Request 1753 (Data Set CR) (Amd 60/2019) + +Documentation from previous releases are available on request from standards.assurance@nhs.net  + +Last edited: 11 January 2022 7:54 am \ No newline at end of file diff --git a/baselineTexts/data-security-and-protection-toolkit.txt b/baselineTexts/data-security-and-protection-toolkit.txt new file mode 100644 index 0000000..69f7b6d --- /dev/null +++ b/baselineTexts/data-security-and-protection-toolkit.txt @@ -0,0 +1,117 @@ +DAPB0086: Data Security and Protection Toolkit + +The Data Security and Protection (DSP) Toolkit is an online tool that enables relevant organisations to measure their performance against the data security and information governance requirements mandated by the Department of Health and Social Care, notably the 10 data security standards set by the National Data Guardian. + +Page contents +Top of page +About this information standard +Release for 2022-23 (3 August 2022 to 30 June 2023) +Release for 2021-22 (20 July 2021 to 30 June 2022) +Release for 2020-21 (10 December 2020 to 30 June 2021) +Release for 2019-20 (1 April 2019 to 30 September 2020) +Release for 2018-19 (1 April 2018 to 31 March 2019) +Updates +About this information standard + +The Data Security and Protection (DSP) Toolkit is an online tool that enables relevant organisations to measure their performance against the data security and information governance requirements mandated by the Department of Health and Social Care (DHSC), notably the 10 data security standards set out by the National Data Guardian in the 2016 Review of data security, consent and opt-outs. + +All organisations that have access to NHS patient data and systems must use this Toolkit to provide assurance that they are practising good data security and that personal information is handled correctly. Such organisations are required to carry out self-assessments of their compliance against the assertions and evidence contained within the DSP Toolkit. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the Specification and Implementation Documents provide further detail for those who have to implement the information standard. + +Release for 2022-23 (3 August 2022 to 30 June 2023) +Release date 3 August 2022 +Release number Amd 23/2022 +Release title Version 5.0 +Stage Implementation  +Key documents +Information Standards Notice (Amd 23/2022) +Requirements Specification (Amd 23/2022) +Appendix 1 - Assertions and Evidence Statements v1.2 (Amd 23/2022) +Change Specification v1.1 (Amd 23/2022) +Implementation Guide (Amd 23/2022) +Corrigendum (Amd 23/2022) (September 2022) + + + +Further information + +  Full details and help information is available on the NHS Digital's Data Security and Protection Toolkit website. + +  + +Release for 2021-22 (20 July 2021 to 30 June 2022) +Release date 20 July 2021  +Release number Amd 36/2021 +Release title Version 4.0 +Stage Superseded by Amd 23/2022 +Key documents +Information Standards Notice (Amd 36/2021) +Requirements Specification (Amd 36/2021) +Appendix 1 - Assertions and Evidence Statements v1.1 (Amd 36/2021) (May 2022) +Change Specification v1.1 (Amd 36/2021) (May 2022) +Appendix  A - DSP Toolkit 2020-21 (version 3.1) to 2021-22 (version 4.0) mapping v1.1 (Amd 36/2021) (May 2022) +Implementation Guide (Amd 36/2021) +Corrigendum (Amd 36/2021) (May 2022) + +  + +Release for 2020-21 (10 December 2020 to 30 June 2021) +Release date 10 December 2020 +Release number Amd 71/2020 +Release title Version 3.1 +Stage Superseded by Amd 36/2021 +Key documents +Information Standards Notice (Amd 71/2020) (Version 2.0) +Requirements Specification (Amd 71/2020) +Appendix 1 - Assertions and Evidence Statements (Amd 71/2020) +Change Specification (Amd 71/2020) Version 2.0) +Appendix  A - DSP Toolkit 2019-20 (version 2) to 2020-21 (version 3.1) mapping (Amd 71/2020) +Implementation Guide (Amd 71/2020) + +  + +Release for 2019-20 (1 April 2019 to 30 September 2020) +Release date 29 May 2019 +Release number Amd 9/2019 +Release title Version 2.0 +Stage Superseded by Amd 71/2020 +Key documents +Information Standards Notice (Amd 9/2019) +Requirements Specification (Amd 9/2019) +Appendix 1 - Assertions and Evidence Statements (Amd 9/2019) +Change Specification (Amd 9/2019) +Appendix A - DSP Toolkit 2018-19 (version 1) to 2019-20 (version 2) mapping (Amd 9/2019) +Implementation Guide (Amd 9/2019) +Release for 2018-19 (1 April 2018 to 31 March 2019) + +  + +Release date 8 March 2018 +Release number Amd 58/2017 +Release title Version 1.0 +Stage Superseded by Amd 9/2019 +Key documents +Requirements Specification (Amd 58/2017) +Appendix 1 - Assertions and Evidence Statements (Amd 58/2017) +Change Specification (Amd 58/2017) +Appendix A - IG Toolkit to DSP Toolkit Mapping (Amd 58/2017) +Implementation Guide (Amd 58/2017) +Information Standards Notice (Amd 58/2017) +Updates + +6 September 2022: Publication of Corrigendum in respect of Version 5.0 (Amd 23/2022), supported by changes to the Requirements Specification: Appendix 1 (uplifted to document version 1.2). See Corrigendum in the table 'Release for 2022-23 (3 August 2022 to 30 June 2023)' above, for full details. + +11 August 2022: Following publication of Version 5.0 (Amd 23/2022) on the 3 August 2022, an error was identified in the Requirements Specification - Appendix 1, in relation to mandatory nature of three requirements: 10.2.4, 8.1.3 and 10.2.3.  The Requirements Specification - Appendix 1 document has now been updated with the corrections. + +In addition, the 'Total number of mandatory evidence items 2022-23 v5' for Category 1 organisations has been adjusted in the Change Specification (figure 2, page 7) from 112 to 113.  + +Both updated documents are available in the 2022-23 release table above (as 'Version 1.1').  + +19 May 2022: Publication of Corrigendum in respect of Version 4.0 (Amd 36/2021), supported by changes to the Change Specification, Change Specification: Appendix A and Requirements Specification: Appendix 1 (all uplifted to document version 1.1). See Corrigendum in the table 'Release for 2021-22 (20 July 2021 to 30 June 2022)' above, for full details. + +12 February 2021: Following publication of Version 3.1 in December 2020, an error was identified in the the Change Specification and Information Standards Notice (ISN), in relation to the description of the changes. This has now been corrected, and the correction has been signposted with a footnote in the updated documents, which are are available above (as 'Version 2.0').  + +10 December 2020: Note that Version 3.0 of the DSP Toolkit (Amd 89/2019) was released in April 2020 but, due to the extension to the conformance date of Version 2.0 of the DSP Toolkit, Version 3.0 was not implemented. Version 3.0 is now withdrawn as it is wholly superseded by Version 3.1 (above).  Documents for Version 3.0 have been removed from this page but are available on request from standards.assurance@nhs.net  + +Last edited: 6 September 2022 10:35 am \ No newline at end of file diff --git a/baselineTexts/diabetes-information-record-standard.txt b/baselineTexts/diabetes-information-record-standard.txt new file mode 100644 index 0000000..179644f --- /dev/null +++ b/baselineTexts/diabetes-information-record-standard.txt @@ -0,0 +1,233 @@ +Diabetes standards + +There are approximately 4.8 million people living with diabetes in the UK and this is expected to rise to 5.3 million by 2025. It is a condition that is predominately self-managed and people with diabetes need education and support from health and care professionals across multiple care settings. + +People are increasingly using medical devices to help manage their diabetes. These include devices for monitoring glucose and delivering insulin.  + +It is important that health and care professionals can access information about a person with diabetes and the data from the medical devices they are using to enable them to provide the best advice and support but this information is often not available or easy to view in one place.  + +On this page +About the standards +Examples of the standards in use  +Key findings +The standards and supporting documentation +Next steps +About the standards + +PRSB was commissioned by NHS England and NHS Improvement to produce standards for sharing diabetes information between people and professionals across all care settings, including self management data from digital apps and medical devices (e.g. continuous glucose monitors). + +  +Current information sharing issues + +Information about a person’s diabetes is not all being digitally shared between the different professionals involved in their care. For example, information recorded by community nurses or podiatrists is not always available to GPs or hospital doctors and information such as latest HbA1c test results are not always shared across systems. This means that a person may be asked back for repeat tests. + +Digital and technological innovations are delivering tools and devices to help people better self-manage their diabetes and the number of people offered them is growing, but it can be hard for people to understand and interpret the data and they may need help with this. Professionals are unable to bring together data from different devices to have a complete view. + +There is inconsistency in use of codes to record information related to a diabetes diagnosis, there are a number of similar SNOMED CT codes and it is not clear which codes should be used particularly when there is an indeterminate diagnosis. + +PRSB has developed two standards to address these information sharing issues. + +The Diabetes Information Record Standard +This defines the information needed to support a person’s diabetes management. It includes information that could be recorded by health and care professionals or the person themselves that is relevant to the diabetes care of the person and should be shared between different care providers. +The Diabetes Self-Management Standard +This defines information that could be recorded by the person (or their carer) at home (either using digital apps or medical devices) and shared with health and care professionals. + +  + +These standards are based what professionals and people with diabetes have told us that they want recorded and shared. + +What is included? +The standards were developed with UK wide consultation and engagement to meet the needs of all four UK nations. +The standards are intended for all types of diabetes mellitus (except ‘prediabetes’). +The standards were designed to support the 9 care processes for diabetes (glycated haemoglobin (HbA1c), blood pressure, cholesterol, urinary albumin, serum creatinine, weight, foot checks, retinal screening and smoking status), glucose monitoring and insulin dosing. +The standards cover all ages including children. +The standards include the information needed by health and care professionals about family planning and pregnancy to manage the diabetes but not everything needed to manage the pregnancy. The Maternity Record Standard sets out the information structure and content for managing a pregnancy. +The standards are relevant for a wide variety of healthcare settings including primary care, secondary care and community and social care settings (e.g. care homes and domiciliary care). +The National Diabetes Audits (for adults and children) were considered in the development of these standards with the aim of enabling information recorded for the purposes of direct care to be reused for the audits. +What is not in scope +Prisons, schools, police and armed forces – some of the information in the standard may work for some of these settings but it was not tested in consultation. +How the information should be presented to the person viewing it e.g. graphs or summary dashboards or who should be able see or change what information. +A definition of where the information should come from, how it should be processed and how and where it should be stored. +Examples of the standards in use + +Here is an example of how the Diabetes Information Record Standard might be used. The example shows the information that could be recorded and shared between the person and their different care providers. + +Ayra’s story +About Ayra and her condition + + +Ayra is a 45-year-old female of Sri-Lankan origin who works as a healthcare assistant at her local hospital, a job which is largely spent at a desk. She has smoked a pack of cigarettes a day for 5 years She has a family history of type 2 diabetes. + + +She was diagnosed with type 2 diabetes a year ago and has been self-managing with metformin, increasing her movement and trying to cut down on smoking after being referred to a smoking cessation service. She has found it difficult to make dietary changes. + + +Ayra is invited by her GP surgery for her annual diabetes review and is asked to attend an appointment 3 weeks before this is due with the healthcare assistant for tests. The healthcare assistant goes through a number of standard care process measures including an assessment of Ayra’s feet, measures her blood pressure and weight, and collects the urine and blood samples to be sent off to the lab for testing. The healthcare assistant checks Ayra’s diabetes record to see whether Arya had attended the eye screening service within the last 12 months. + + +The healthcare assistant informs Ayra she will be contacted when the results return from her urine and blood tests, so that she can see them before her annual review. +Getting her test results +Ayra receives the results from her tests + + +The results have been annotated and colour coded for ease of reference and understanding. She is concerned that although her HbA1c result has improved it is still showing as red (65mmol/mol) and her blood pressure (146/94 mmHg) and BMI (31.3) have both increased. Her urine test results show an increased risk of kidney disease (moderately increased albuminuria). Her foot check and eye screening results are normal. + + +Ayra completes a form before her appointment setting out that she wants to discuss eating a better diet, as that is important to her. She is also keen to do more exercise and is worried about her high blood sugar and kidneys in particular. +Attending the review +Ayra returns for her annual review appointment at the surgery + + +Ayra is booked in to see the practice nurse. Ayra remembers to bring her results sheet with her and other notes she has made about what she wants to talk about at the appointment. The practice nurse reviews Ayra’s medical records before the appointment and notes that she is only using metformin for her blood glucose control. She also notes the results for blood pressure and urine as well as the rise in weight. Ayra is able to sit down with the nurse and discuss her results in a collaborative and supportive way. She highlights the main things that are bothering her and is surprised to hear about the impact of blood pressure on kidney health. + + +Ayra decides that she would like to take more care of her blood pressure as well and agrees to start a new tablet for blood pressure. She also decides to get a blood pressure monitor to check things at home and say that she will update the nurse with her blood pressure readings after starting the new medicine. + + +Ayra admits that her weight bothers her and the nurse suggests a few things she could work on to try and help with that. The important parts of the discussion are recorded in Ayra’s medical records as a care plan. The care plan is broken down into a summary of the conversation; goals and actions are listed alongside obstacles and resources she could potentially use to help. Ayra is given a copy of this care plan to take away and refer to after the appointment. + + +The nurse suggests that it would be a good idea to follow up her progress in 3 months’ time but that Ayra can send her blood pressure readings in the meantime to help adjust her new tablet. They agree that other tablets and treatments might be needed for her blood glucose in the future but Ayra would prefer to focus on her dietary intake and new blood pressure medicine first. She feels confident with the goals she has set and the nurse notes the plan and that confidence down. +Follow up +After the review and the follow up appointment + + +Ayra purchases a blood pressure monitor online and starts to check her blood pressure regularly. She contacts the nurse and sends blood pressure readings online for the nurse to review. This helps the nurse to adjust the medication dose accordingly. Ayra continues to struggle with dietary changes but is pleased that her blood pressure is improving. + + +Ayra books a follow up appointment with the healthcare assistant a little later than planned and gets her blood glucose, weight and blood pressure repeated along with her kidney health tests. She has a better understanding of the results now and is more active in the consultation. This time, the appointment is with one of the doctors. The doctor reviews the previous care plan and checks progress. Ayra is aware that the blood glucose and weight remain outliers in terms of her results but she is pleased with the remaining results. She agrees to start a new tablet for her blood glucose and a further follow up is planned based on that. The doctor advises that she can reduce the frequency of blood pressure checks now and Ayra agrees a new set of goals for her dietary intake to try ahead of her next appointment. + +Here is an example of how the The Diabetes Self-Management Standard might be used. The example shows how self-management data can be captured by a person with Type 1 Diabetes and shared remotely with their consultant. + +Alicia’s story +About Alicia and her condition + + +Alicia is a 21-year-old woman with Type 1 diabetes who lives at home with her parents. She has had diabetes since the age of 10. Alicia recently graduated from university and is now studying for a teaching qualification in her hometown. + + +She lives an active lifestyle, very rarely drinks and is a non-smoker. She has a passion for long distance running. + + +Before she went to university, her mother used to help her with regular fingerstick testing to measure her blood sugars levels. She moved from paediatric care to adult care just before she went to university. During the time she was at university, her glucose control suffered as her blood sugar monitoring dropped off, but she had no significant acute problems other than one admission to hospital for diarrhoea and vomiting, complicated by ketosis. + + +On her return from university, she was given a flash glucose monitor when she attended a refresher education session. + + +Alicia shares the data from her glucose monitor with her specialist diabetes team via her smartphone so that her consultant can view the data at her next appointment or if she contacts him . +Self-management +Alicia’s self-management on a typical day + + +Alicia wakes up and scans her sensor to check her blood sugars levels to determine if any correction is needed and to ensure her control overnight has been stable. + + +Before breakfast Alicia works out how much carbohydrate she is going to have in her meal and calculates the amount of bolus insulin to give herself using both an individualised insulin to carbohydrate ratio (1unit per 12g carb) and an individualised sensitivity factor (1unit for 4mmol/L) and glucose target (7.5mmol/L). If she plans to exercise she has an adjustment factor for her bolus insulin dose. + + +After breakfast she scans her sensor and again before exercising. She eats a snack before exercising if her blood sugar levels are below 7 to try and ensure she does not become hypoglycaemic during her run. + + +Alicia goes for a run (between 45 and 80 mins usually) ensuring that her sensor alarms are set and working beforehand and then checks her blood sugars. Typically, her levels are low after exercise, so she has a snack high in carbohydrates. + + +Alicia scans her sensor again, both before lunch and evening meal, to check her blood sugars and calculates her bolus insulin dose. At these mealtimes she uses individualised carb and correction ratios for her calculations that are slightly less aggressive than her breakfast ratios. + + +Around 9pm she checks her blood sugars and administers her daily basal insulin injection (insulin glargine). Before bed she scans her sensor a final time before going to sleep. +The hospital appointment +Reviewing the self-management data + + +Alicia attends a review with her consultant diabetologist. She had submitted information in advance of the appointment to say that she wants to talk about her concerns. Since returning home from university she has found that her blood sugar levels are increased following long distance runs instead of dropping as was previously the case. This has worsened over the last week or so and she is worried and frustrated about the change. + + +The consultant checks Alicia’s diabetes record and notes that she has never smoked, has had no hospital admissions due to diabetes in the last 12 months and that she had attended the refresher DAFNE structured education course she had been referred to. He asks about her experiences using the glucose sensor and whether this has helped with her self-management decisions. + + +The consultant asks Alicia questions about the pre-clinic preparatory data which she’s provided in the form of questionnaire responses including her confidence in carbohydrate counting, awareness of hypoglycaemia (Gold score) and the demands of living with diabetes (Diabetes Distress Score 2 (DDS2)). He notes her distress score has increased and explores with her the reasons why this may have occurred and how she can access support if it’s needed. + + +Her consultant looks at the data that Alicia had made available from her glucose sensor and can see from the last 14 days of data that the blood sugar levels are initially around 5 – 8 mmol/L before exercise, they then decrease to 3 – 4 mmol/L at the end of her runs and then increase up to 13 – 18 mmol/L as she recovers. As a result of this on the days when she’s run, her glucose variability is significantly higher and less predictable than on the days when she does not run, which is the cause of her frustration. + + +The consultant congratulates her on her degree and asks her about her plans now she’s returned from university. He then comments on the general control of her sugar levels which he assesses as good based on her overall sensor data and most recent HbA1c and asks if she has any other health concerns. + + +He then explores the issue of concern around exercise with Alicia including how she plans for her runs (what exercise correction she applies at breakfast), the timing of her runs (and if this could be altered to a time when her short-acting insulin is less active), the impact of different lengths of run and the potential need for isotonic drinks to provide carbohydrate during the runs, the impact of different types of exercise and her menstrual cycle in her exercise responses. + +In particular, he focusses on the role of her post exercise snack and the low glucose levels at the end of exercise as a trigger for her later hyperglycaemia. The consultant mentions the possibility of using a connected pen to monitor her insulin doses more closely around the days when she exercises in order to determine which strategies work best for her, which she agrees to consider. He recommends further information resources which she can access to investigate this (online) and makes sure she has the contact details for the local diabetes support group and exercise interest group. + +Between them they agree on a strategy and how to make plans to address the issues she’s raised including a virtual review of her data after 2-3 weeks. In addition to the detailed discussion, he gives safety-netting advice about her runs including wearing her diabetes alert bracelet/ID and continuing to take snacks with her in case of hypos. +Key findings + +There were a number of key points raised by healthcare professionals and people with diabetes during the consultation phase of these standards. These are the highlights of the consultation findings. For more information, please read the final report. + + +Better support is needed for understanding complex information + +There can be vast amounts of complex data and information available to people with diabetes, and they need on-going support with this. Some health and care staff also need education on this so that they are able to advise people on self-management. There also needs to be a consistent focus on primary support staff, privately employed carers or carers commissioned from private and sometime very small providers as well as staff in care homes. Their understanding, skills and abilities and ability to input to and access systems is fundamental.  + + +Consider digital poverty and inequalities + +With the rise in use of medical devices for self-monitoring and self-management it is important to consider digital poverty and not exacerbate inequalities such as for those in areas with no internet access, or those less able to use digital technologies. + + + +Concern about the potential volume of data + +Concerns were raised about the volume of information and the potential numbers of individuals who would be able to share information from their apps and medical devices, including workload and capacity issues related to managing, monitoring and reviewing the information on a regular basis. There was a general lack of clarity of liability in a scenario where an individual develops complications or urgent clinical issue which could potentially have been identified from the data but had not been reviewed and/or acted upon. It was suggested that this could be addressed through clear, evidenced, communication about when the data will be reviewed, at the point at which the person is initially given the device. + + +Validated self-management data is important + +People with diabetes are experts in their condition and use many different types of information in the daily management of their condition and want to be able to share that information with professionals to inform their consultations. Validated information recorded and shared by a person with diabetes is important in day-to-day condition management and should not be disregarded by health and care professionals. + + +Access to self-management data + +People with diabetes also want to be able to control who has access to the information that they have recorded at home. It was noted that there are risks if people do not share the information, or share partial information, as it means that health and care professionals cannot provide advice based on accurate information about a person and it can lead to poorer decisions and on occasions to incorrect diagnoses especially for patients with complex multi-system disorders. + +Next steps + +PRSB is now working with NHS Digital on terminology, to specify how the information is coded, and technical standards (based on FHIR UK Core), to specify how information is to be held or moved between systems. + +This will support the consistent recording of information and will enable information to be sent and received between clinical systems (and digital apps and medical devices). The standards will then be piloted. + +Current release +Current release +Date: June 2022 +Version: V1.0 + +Diabetes Information Record Standard  + +Standards viewer +Excel file +Json file + + +Diabetes Self-Management Data Standard + +Standards viewer +Excel file +Json file + +Supporting documents +General implementation guidance +(Detailed guidance, specific to the sections and elements of the standard, are included within the information model) +Final report +Survey report +Safety case report +Hazard log +  +  +Further resources +IHRIM record correction guidance +Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. +  +Endorsement +Endorsement is in progress for the draft standard and details will be published here when this work is complete.  +  +  \ No newline at end of file diff --git a/baselineTexts/diagnostic-imaging-data-set.txt b/baselineTexts/diagnostic-imaging-data-set.txt new file mode 100644 index 0000000..e394ec1 --- /dev/null +++ b/baselineTexts/diagnostic-imaging-data-set.txt @@ -0,0 +1,27 @@ +SCCI1577: Diagnostic Imaging Data Set + +The Diagnostic Imaging Data set (DID) is a central collection of detailed information about diagnostic imaging tests carried out on NHS patients, to be extracted and submitted monthly. + +Page contents +Top of page +About this information standard +Current release +About this information standard + +The Diagnostic Imaging Data set (DID) is a central collection of detailed information about diagnostic imaging tests carried out on NHS patients, to be extracted and submitted monthly. It captures information about referral source and patient type, details of the test (type of test and body site), demographic information such as GP registered practice, patient postcode, ethnicity, gender and date of birth, plus items about waiting times for each diagnostic imaging event, from time of test request through to time of reporting. + +Note that this information standard, formerly approved by the Information Standards Board for Health and Social Care (ISB), has been assured by SCCI as suitable for publication under section 250 of the Health and Social Care Act 2012. While no changes have been made to the content of the standard, the key documents below have been updated to reflect the owning organisation's branding guidelines. + +Current release +Release date 05/10/2016 +Release number Amd 10/2011 +Release title Initial Standard: Conversion +Stage Implementation +Key documents +Requirements Specification (Amd 10/2011) +Guidance document (Amd 10/2011) [Archive Content] +Information Standards Notice (Amd 10/2011) + +Further information DID dataset pages + +Last edited: 5 November 2018 12:12 pm \ No newline at end of file diff --git a/baselineTexts/dictionary-of-medicines-and-devices-dmd.txt b/baselineTexts/dictionary-of-medicines-and-devices-dmd.txt index 1bda891..f80c3b4 100644 --- a/baselineTexts/dictionary-of-medicines-and-devices-dmd.txt +++ b/baselineTexts/dictionary-of-medicines-and-devices-dmd.txt @@ -18,8 +18,8 @@ Release number Amd 13/2013 Release title Conversion under the Health and Social Care Act 2012 Stage Implementation Key documents -Requirement Specification (Amd 13/2013)  -Implementation Guidance (Amd 13/2013) +Requirement Specification (Amd 13/2013) [Archive Content]  +Implementation Guidance (Amd 13/2013) [Archive Content] Information Standards Notice (Amd 13/2013) Guidance documents Further information about dm+d is available on the website of NHS Prescription Services diff --git a/baselineTexts/digital-child-health-fhir-api.txt b/baselineTexts/digital-child-health-fhir-api.txt index b005a42..0f92890 100644 --- a/baselineTexts/digital-child-health-fhir-api.txt +++ b/baselineTexts/digital-child-health-fhir-api.txt @@ -1,13 +1,13 @@ -Digital Child Health - FHIR API +Digital Child Health - FHIR Share information about a child's health between healthcare workers.  Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -16,8 +16,29 @@ Environments and testing Onboarding Interactions Overview +Sending System -Use this API to share information about a child's health between healthcare workers. +NEMS +publish event +MESH + +send event to all +subscribing systems + +Subscribed +System B + +Subscribed +System A + +Subscribed +System C + +manage subscriptions + +  + +Use this integration to share information about a child's health between healthcare workers. This information is recorded throughout a child's clinical pathway or patient journey about: @@ -35,19 +56,17 @@ blood spot test outcome newborn hearing test Newborn and Infant Physical Examination (NIPE) outcome -This API enables the sharing of information about these events in the form of small, structured and interoperable health event FHIR messages. - -A publication-subscription model allows sharing of this information, in a controlled way, with health and care workers in other organisations such as GPs, Emergency Departments and Local Authorities. This uses our National Events Management Service (NEMS). +This integration uses a publish-subscribe model - the sending system publishes events to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via MESH. -Potentially, patients and carers could also share this information. +Subscribed systems might be GPs, emergency departments, local authorities or some other care provider. Potentially, patients and carers could also share this information. -For more information see Digital Child Health - FHIR API. +For more information see Digital Child Health specification versions. -Before you begin any development work using this API, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. To do this, contact us.  @@ -57,31 +76,31 @@ You must do this before you can go live (see 'Onboarding' below). Related APIs -The following APIs and API standard are also related to this API: +The following APIs and integrations are also related to this one: -National Events Management Service (NEMS) API - use this API to publish and subscribe to patient-centric event messages +National Events Management Service (NEMS) - use this to publish and subscribe to patient-centric event messages -Message Exchange for Social Care and Health (MESH) API - use this API to collect events that you have subscribed to +Message Exchange for Social Care and Health (MESH) API - use this to collect events that you have subscribed to -Child Protection - Information Sharing - HL7 V3 API - use this API to access child protection information from Child Protection - Information Sharing (CP-IS) as a local authority or an unscheduled care provider using our HL7 V3 API +Child Protection - Information Sharing - HL7 V3 API - use this to access child protection information from Child Protection - Information Sharing (CP-IS) as a local authority or an unscheduled care provider using our HL7 V3 API -API status +Status -This API is in beta. +This integration is in production. Service level -This API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. +This integration uses FHIR. It uses a publish-subscribe model and is specifically based on the HL7 FHIR STU3 Messaging Implementation. -Use our National Events Management Service (NEMS) API to subscribe to events. +Use our National Events Management Service (NEMS) integration to subscribe to events. Use our MESH API to collect event messages that you have subscribed to. @@ -89,13 +108,13 @@ For more details, see FHIR. Network access -This API is available on the internet and on the Health and Social Care Network (HSCN). +This integration is available on the internet and on the Health and Social Care Network (HSCN). For more details see Network access for APIs. Security and authorisation -This API uses NEMS and MESH APIs which are application-restricted, meaning we authenticate the calling application but not the end user. +This integration uses NEMS and the MESH API which are application-restricted, meaning we authenticate the calling application but not the end user. You can use this pattern as follows: @@ -103,7 +122,7 @@ unattended (end user not present), for example as part of a back end process to attended (end user present) - in which case, you must ensure the end user is authenticated and suitably authorised locally by the calling application -In particular, this API uses TLS-MA authentication. +In particular, this integration uses TLS-MA authentication. It also implements authorisation controls which restrict the event types that the connecting application can subscribe to or publish. @@ -111,7 +130,7 @@ For more details, see application-restricted APIs. Environments and testing -This API uses NEMS, which is available in Opentest for early development and testing. +This integration uses NEMS, which is available in Opentest for early development and testing. NEMS is also available for testing purposes in: @@ -151,15 +170,15 @@ For more details, see the NEMS onboarding guide on getting access to Opentest an Onboarding -You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. +You need to get your software approved by us before it can go live with this integration. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. -To outline your use case and start the onboarding process for this API, contact us. +To outline your use case and start the onboarding process for this integration, contact us. Interactions -For a full list of interactions for this API, see Publish an Event Message and Subscriptions Overview. +For a full list of interactions for this integration, see Publish an Event Message and Subscriptions Overview. -This API supports the following event types: +This integration supports the following event types: Blood Spot Test Outcome Newborn Hearing @@ -169,4 +188,4 @@ Vaccinations For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 3:18 pm \ No newline at end of file +Last edited: 13 October 2022 5:28 pm \ No newline at end of file diff --git a/baselineTexts/digital-maternity-api-standards.txt b/baselineTexts/digital-maternity-api-standards.txt index 4d492c3..c3f111a 100644 --- a/baselineTexts/digital-maternity-api-standards.txt +++ b/baselineTexts/digital-maternity-api-standards.txt @@ -5,6 +5,7 @@ API standards to enable sharing and updating of digital maternity records. Page contents Top of page Overview +API status API standards Overview @@ -14,6 +15,10 @@ For more details, see the Digital maternity specifications - developer guidance NHSX has taken over responsibility for the delivery of the Digital Maternity programme. If you have any questions about future digital maternity work please email england.digitalmaternitynhsx@nhs.net. +API status + +This API standard is experimental - an early pre-alpha version under development. + API standards Year  Name Version Status & Notes Links 2019 @@ -25,4 +30,4 @@ Experimental Experimental - for consultation and discussion only https://develo   -Last edited: 28 September 2021 12:33 pm \ No newline at end of file +Last edited: 31 May 2022 5:18 pm \ No newline at end of file diff --git a/baselineTexts/digital-medicine-fhir.txt b/baselineTexts/digital-medicine-fhir.txt new file mode 100644 index 0000000..1371b9a --- /dev/null +++ b/baselineTexts/digital-medicine-fhir.txt @@ -0,0 +1,151 @@ +Digital Medicine - FHIR + +Notify a patient's registered GP practice about care services delivered at a pharmacy, such as an immunisation. + +Page contents +Top of page +Overview +Who can use this +Related APIs +Status +Service level +Technology +Network access +Security and authorisation +Environments and testing +Onboarding +Interactions + +Three use cases for this integration are now retired. + +For more details, see status. + +Overview +Pharmacy system +MESH +Patient's registered GP system +send  care notifications +receive care notifications + +  + +Use this integration to notify a patient's registered GP practice about care services delivered at a pharmacy. + +You can send notifications about: + +an immunisation given + +an emergency medication dispensed without a prescription + +a minor illness referral consultation + +This integration uses MESH to send and receive messages. + +The following use cases are now retired and you cannot use them: + +a medication review + +an appliance use review + +a New Medicine Service (NMS) appointment + +For more details, see status. + +Who can use this + +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. + +You must do this before you can go live (see ‘Onboarding’ below). + +Related APIs + +The following API is related to this integration: + +Message Exchange for Social Care and Health (MESH) API - use this API to transfer messages and large files securely across health and social care organisations + +Additionally, use the following API standard to implement this integration: + +Interoperability Toolkit 3 Messaging Distribution FHIR API standards - use this API standard to implement a set of generic messaging components using HL7 FHIR STU3 to create a unified approach to NHS message and document flows across England +Status + +This integration consists of six different notification types. The status of each message type is as follows: + +Notification type Status +immunisation private beta - in active use, but with a limited number of connecting applications  +emergency medication dispensed without prescription private beta - in active use, but with a limited number of connecting applications +minor illness referral consultation private beta - in active use, but with a limited number of connecting applications +medication review now retired +appliance use review now retired +New Medicine Service (NMS) review now retired + +If you would like to be involved in our beta programme, contact us. + +Service level + +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. + +For more details, see service levels. + +Technology + +This is an asynchronous messaging integration. The notifications take the form of FHIR STU3 messages sent via MESH. + +For more details, see FHIR and MESH. + +Network access + +You can access this integration via: + +the Health and Social Care Network (HSCN) + +the internet + +For more details, see Network access for APIs. + +Security and authorisation + +This integration uses MESH which is an application-restricted API. + +The integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. + +For more details see our national RBAC database on the registration authorities and smartcards page. + +Environments and testing + +This integration uses MESH. + +As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. + +For more details about using the MESH client, see MESH client. + +For the MESH API, there are several independent, externally accessible instances of MESH you can use for testing. For full details, see MESH API - Environments and testing. + +Onboarding + +You need to get your software approved by us before it can go live with this integration. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. + +To onboard for this API, contact us. + +Interactions + +For details on the general structure of the interactions, see FHIR. + +The following versions are published: + +Status Release version Release date Details +Private beta 1.2.7-Private Beta 29 September 2022 Clarification of Minor Illness Referral Consultation specification +Private beta 1.2.6-Private Beta 22 April 2022 Clarification around implementation of Emergency Supply +Private beta 1.2.5-Private Beta 19 March 2021 Change from Digital Minor Illness Referral Service to Minor Illness Referral Consultation +Private beta 1.2.4-Private Beta 3 March 2021 Example scenarios for COVID vaccination flows +Private beta 1.2.3-Private Beta 4 May 2020   +Private beta 1.2.2-Private-Beta 1 April 2020 Current Private Beta version of the specification +Private beta 1.2.1-Private-Beta 2 December 2019 Version 1.2.1-Private-Beta +Private beta 1.2.0-Private-Beta 30 September 2019 Version 1.2.0-Private-Beta +Alpha 1.1.3-Alpha 9 August 2019 Version 1.1.3-Alpha +Alpha 1.1.2-Alpha 26 July 2019 Version 1.1.2-Alpha +Alpha 1.1.1-Alpha 8 July 2019 Version 1.1.1-Alpha +Alpha 1.1.0-Alpha 19 March 2019 Version 1.1.0-Alpha + +  + +Last edited: 29 September 2022 4:45 pm \ No newline at end of file diff --git a/baselineTexts/document-naming.txt b/baselineTexts/document-naming.txt index f9c5223..d5ad1fc 100644 --- a/baselineTexts/document-naming.txt +++ b/baselineTexts/document-naming.txt @@ -2,7 +2,6 @@ Document naming Electronic Health and care records can include a significant number of documents, these may have originated from digital systems or scanned paper documents.  We require a standardised way of attributing information to those documents so they can easily be found when needed, particularly in an emergency. We also need to ensure they can be exchanged efficiently between different systems. - Often, information about a person’s previous care may be held on a number of different IT systems; a variety of options being available to provide a single view to a patient’s digital record. Documents form one part of such information and may have been captured in a number of ways, for example: as a pdf which has been exported from an IT system @@ -10,8 +9,6 @@ a scanned document: In their efforts to create a full set of digital notes, many As a word-processed unstructured document As a pointer to file in a document management system. -  - As a result, without appropriate additional data (referred to as metadata), these are often hard to find or even know they exist, and can be difficult to retrieve, thus increasing the risk of error. The document naming standard aims to ensure that records are properly named and indexed so they can be retrieved in order to provide ongoing care. Efficient retrieval can enable end users to compare and contrast previous test results, scans and other information, and patients won’t have to repeat complicated medical histories. @@ -35,7 +32,7 @@ PRSB have undertaken a recent review in this area with recommendations for two s However, in light of the work that has recently started on the International Patient Summary (IPS), and with guidance from the UK Strategy Board, the PRSB has agreed to defer any further development until the outcomes of the IPS work are published. -The standard +The standard: V4.1 July 2022 Standards relating to document naming exist in Scotland and Wales; given developments on the International Patient Summary, PRSB are currently signposting to those existing standards rather than looking to develop an updated UK standard. The following are available on the respective websites: @@ -46,10 +43,9 @@ A standard for the metadata in the document management system (managed by NHS Wa * Note that each UK country may publish their own Value lists for the Clinical specialty data item. Supporting documents - Fact Sheet (pdf) -Clinical Document Indexing Standard – notes of Guidance: published by Public Health Scotland. +Clinical Document Indexing Standard – notes of Guidance: : published by Public Health Scotland. IHRIM record correction guidance diff --git a/baselineTexts/edischarge-summary.txt b/baselineTexts/edischarge-summary.txt index 757af0c..ad21405 100644 --- a/baselineTexts/edischarge-summary.txt +++ b/baselineTexts/edischarge-summary.txt @@ -37,8 +37,15 @@ Royal College of Surgeons* The PRSB and its members will work to ensure key stakeholders are sighted on these current limiting factors and act on them and we will influence suppliers to deliver appropriate systems that enable use of clinical information standards, without increasing burden. The Standard + eDischarge summary standard -Release Notes V2.1 V2.1 (Dec 2019) includes an update to: – structured dose direction cluster – structured dose amount – structured dose timing and dose direction duration. + +Release Notes V2.1 +V2.1 (Dec 2019) includes an update to: +– structured dose direction cluster +– structured dose amount +– structured dose timing and dose direction duration. + Release notes V1.1 Release notes V2 Supporting documentation @@ -49,7 +56,7 @@ Hazard log – excel file Transfer of care FHIR specifications Information Standards Notice (ISN) Case study description -Example discharge summary (based on the case study)The example demonstrates how the headings developed can be structured in a discharge summary for a patient in a given scenario. The example provides varied content to illustrate mapping to the PRSB standard. The example and scenario description were quality assured by the PRSB assurance committee. +Example discharge summary (based on the case study) The example demonstrates how the headings developed can be structured in a discharge summary for a patient in a given scenario. The example provides varied content to illustrate mapping to the PRSB standard. The example and scenario description were quality assured by the PRSB assurance committee. IHRIM record correction guidance Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. diff --git a/baselineTexts/electronic-prescribing-and-medicines-administration-api-standards.txt b/baselineTexts/electronic-prescribing-and-medicines-administration-api-standards.txt index 44d7296..cae73eb 100644 --- a/baselineTexts/electronic-prescribing-and-medicines-administration-api-standards.txt +++ b/baselineTexts/electronic-prescribing-and-medicines-administration-api-standards.txt @@ -5,7 +5,7 @@ Use these API standards to share medication requests between ePMA systems and ho Page contents Top of page Overview -API Standard +API status API standards Overview @@ -19,9 +19,9 @@ For more details see Implementation guide for digital medicines. Or contact us at medicinestandards@nhs.net. -API Standard +API status -This API standard is in alpha. +This API standard is in beta. API standards Year Name Version Status & Notes Links @@ -36,4 +36,4 @@ ePMA Implementation Guidance for FHIR STU3   -Last edited: 26 May 2022 2:46 pm \ No newline at end of file +Last edited: 6 June 2022 4:17 pm \ No newline at end of file diff --git a/baselineTexts/electronic-yellow-card-reporting-version-30.txt b/baselineTexts/electronic-yellow-card-reporting-version-30.txt index 21cddac..f0a60db 100644 --- a/baselineTexts/electronic-yellow-card-reporting-version-30.txt +++ b/baselineTexts/electronic-yellow-card-reporting-version-30.txt @@ -27,7 +27,7 @@ Information Standards Notice (Amd 16/2017) Supporting documents Message Fields and Validations XLS (Amd 16/2017) -Message Documents XML (Amd 16/2017) +Message Documents XML (Amd 16/2017) [Archive Content] Previous releases of this information standard can be found on the ISB website (external link) diff --git a/baselineTexts/emergency-care-discharge.txt b/baselineTexts/emergency-care-discharge.txt index 7021b2a..f213c63 100644 --- a/baselineTexts/emergency-care-discharge.txt +++ b/baselineTexts/emergency-care-discharge.txt @@ -19,6 +19,7 @@ Royal Pharmaceutical Society Institute of Health Records and Information Management Tech UK The Standard + Emergency care discharge summary standard Release Notes V2.1 @@ -36,7 +37,9 @@ Transfers or care safety case report Transfers of care hazard log Final report – Emergency Care discharge standard Transfer of care FHIR specifications + Example letters + Emergency Care Example Letter 1 Emergency Care Example Letter 2 Emergency Care Example Letter 3 diff --git a/baselineTexts/eyecare-electronic-referral-service-api-standard.txt b/baselineTexts/eyecare-electronic-referral-service-api-standard.txt new file mode 100644 index 0000000..dfcd216 --- /dev/null +++ b/baselineTexts/eyecare-electronic-referral-service-api-standard.txt @@ -0,0 +1,825 @@ +Eyecare Electronic Referral Service API standard + +Pass details of a new eyecare referral to an Eyecare Electronic Referral System (EeRS). + +This specification is written from an OAS file. + +Get OAS file +Page content +Top of page +Overview +Who can use this API +API status and roadmap +Technology +Network access +Security and authorisation +Onboarding +Endpoints +Create a referral +Get referral status +Overview + +Use this API standard to pass details of a new eyecare referral from an Optometry Patient Management System (Optometry PMS) to an Eyecare electronic Referral system (EeRS). + +The API standard supports sending key referral information (including the GOS18 data items) from an optometrist to NHS services via an EeRS. This is important for engaging optometrists in digital referrals into the NHS, and eliminate double-keying of information documented as part of a sight test or optical consultation. + +Each NHS region will procure an EeRS system from the Dynamic Purchasing System (DPS) for Electronic Eyecare Referral Systems (EeRS). Each EeRS system receives referrals using this API standard and provides its own endpoint for this service. + +This API standard is a published specification only. Therefore you, as an Optometry PMS developer, implement and integrate it directly with each EeRS, not via our services. Therefore, the sending Optometry PMS system needs to link to each EeRS eyecare e-referral endpoint that conforms to the API standard. + +Building the API standard into an Optometry PMS + +Use the following steps to implement the API standard as a sending Optometry PMS to a specific EeRS: + +Identify the data fields in your system that correspond to the data fields in the specification. +Ask the EeRS supplier to provide their API endpoint. +Ask the EeRS supplier you are integrating with to provide a system-to-system API key. +Develop your system to connect to the API and send the API key with the data payload to that EeRS endpoint. +Design a way of initiating the referral process from the Optometry PMS – ideally using a “refer via EeRS” button in the right part of the workflow in your PMS system +Test that referral process is working from your Optomotry PMS to the endpoint with the EeRS, and check with a clinician that the right data fields are coming across inside the EeRS system. +Who can use this API + +This API standard can be provided by any EeRS as procured regionally. It can be used by any Optometry PMS to allow an optometrist to send a referral into a specific EeRS system. Integrated Care Systems may require each Optometry system in use in their area to link to their specific EeRS system. + +API status and roadmap + +This API standard is in beta, meaning: + +it is available for production use +we might make breaking changes, but only if we cannot avoid it, and we will give an advance notice + +To suggest, comment or vote on features for this API, see our interactive product backlog. + +If you have any other queries, please contact us at bookingandreferrals@nhs.net. + +Version control + +We use HTTP headers to allow you to specify the API version you want to call. + +In general, once an API is stable (meaning it has exited beta) we avoid making any breaking changes. That means we might add new data fields or add new valid values to code sets, but we won't remove any mandatory fields or change the semantic meaning of any existing fields or code sets. + +If we ever do need to make breaking changes to a stable API, we will continue to use HTTP headers to allow you to specify the API version you want to call. We'll do this in a backwards-compatible way. + +This spec version: 1.0.0 + +Technology + +This API standard uses RESTful technology, as described in our guidance here. + +Network access + +EeRS supplier API endpoints that conform to this API standard are available on the internet. + +Security and authorisation + +All communications must be encrypted using HTTP(S). + +Each EeRS endpoint must be secured via an API key included in the HTTP header. Note that we recommend the use of an 128-bit API key as a minimum. Liaise with the EeRS supplier you are integrating with, to get an API key for their endpoint configuration. + +Onboarding + +Liaise with NHSX for onboarding your service into live operation. Please contact NHSX at digital.podac@nhsx.nhs.uk. + +Endpoints +Create a referral +POST /referrals +Try this API + +Sends a new referral into the EeRS + +Create a new referral in the EeRS + +Step 1: The cinician user decides to create a referral and clicks “refer via EeRS” or similar on the Optometry PMS system + +Step 2: Optometry PMS gathers the data payload to send via the API + +Step 3: Optometry PMS identifies the EeRS supplier API to call based on the optometry practice where the practitioner has clicked ‘create EeRS referral’ + +Step 4: Optometry PMS initiates API by sending API key to the EeRS in question with the data payload + +Step 5: EeRS provides a response 201 with a URL - or an error message + +Complete the referral in the EeRS + +Step 1: Optometry PMS launches the URL for the user in a browser + +Step 2: The user can now see the data rendered in the EeRS, and can complete the referral. + +Step 3: The user completes the referral using the EeRS. + +Optometry PMS sender guidance + +If there is no value in your Optometry PMS for a non-mandatory nullable field do either one of the following: - exclude that field from the JSON - use JSON NULL to represent an empty field rather than empty string. + +EeRS provider guidance + +Any non-mandatory field will either be included as JSON null or not included at all from the sending Optometry PMS system. When saving a new referral initialise these fields to null in your system. + +Request +Headers +Name Description +Accept-Version + +String + +The version number of the API you wish to call. + +Example: 1.0.0 + + +api-key + +String + +The API Key associated with the calling API consumer. + +Example: KdsASD78FA5Sjl342kfwreas + +Body + +Content type: application/json + +Example + +Copy +{ + "urgent" : "emergencyASAP", + "dateOfSightTest" : "2019-08-24", + "dateOfReferral" : "2019-08-24", + "patient" : { + "NHSNumber" : "1234567890", + "name" : { + "prefix" : "Mrs", + "given" : "Jane", + "family" : "Jones", + "fullName" : null + }, + "gender" : "female", + "address" : { + "line" : [ "1 The Road", "Wetherby", "North Yorkshire" ], + "postcode" : "LS10 1JR" + }, + "telephone" : "01937 123456", + "mobile" : "07545 123456", + "email" : "j.jones@nowhere.com", + "dateOfBirth" : "1997-08-11" + }, + "reasonForReferral" : "Needs assessment for cataract surgery", + "guardian" : { + "name" : { + "prefix" : "Mr", + "given" : "Harry", + "family" : "Jones", + "fullName" : null + }, + "address" : { + "line" : [ "1 Station Road", "Leeds" ], + "postcode" : "LS15 8DT" + } + }, + "referrer" : { + "registrantType" : "GOCRegistrant", + "registrantNumber" : "01-12345", + "name" : { + "prefix" : null, + "given" : "Gosia", + "family" : "Daria", + "fullName" : "Gosia Daria" + }, + "practice" : { + "ODSCode" : "G7H8J", + "name" : "The Eyecare Practice", + "address" : { + "line" : [ "Floor 2", "Poppleton Court", "George Street", "Wakefield" ], + "postcode" : "WF1 1AA" + }, + "email" : "gdaria@theeyecarepracticewakefield.co.uk", + "telephone" : "01924 567890" + } + }, + "GP" : { + "name" : { + "prefix" : "Mr", + "given" : "Harry", + "family" : "Jones", + "fullName" : null + }, + "practice" : { + "ODSCode" : "G7A9I", + "name" : "The Practice", + "address" : { + "line" : [ "1 Station Road", "Leeds" ], + "postcode" : "LS15 8DT" + }, + "email" : "reception@theleedsexamplepractice.nhs.uk", + "telephone" : "0113 212 3456" + } + }, + "GPAction" : "informationOnly", + "referTo" : { + "adultClinic" : "cataract" + }, + "clinicalTerms" : [ "cataract" ], + "refraction" : { + "left" : { + "sphere" : -2, + "cylinder" : 0.75, + "axis" : 70, + "nearPrism" : { + "in" : 1 + }, + "distancePrism" : { + "in" : 1.25, + "down" : 0.75 + }, + "VA" : "6/5", + "pinhole" : "6/6", + "add" : 1.75, + "nearVision" : "n5", + "previousCorrectedVA" : "6/9-3", + "previousCorrectedVADate" : "2019-08-24", + "unaidedVision" : "6/18-2" + }, + "right" : { + "sphere" : -2, + "cylinder" : 0.75, + "axis" : 70, + "nearPrism" : { + "in" : 1 + }, + "distancePrism" : { + "in" : 1.25, + "down" : 0.75 + }, + "VA" : "6/5", + "pinhole" : "6/6", + "add" : 1.75, + "nearVision" : "n5", + "previousCorrectedVA" : "6/9-3", + "previousCorrectedVADate" : "2019-08-24", + "unaidedVision" : "6/18-2" + } + }, + "additionalClinicalFindings" : { + "intraocularPressureTime" : "14:15:22Z", + "tonometerUsed" : "string", + "fieldsInstrumentUsed" : "string", + "left" : { + "visualField" : "normal", + "cdRatio" : 0.3, + "opticDiscAppearance" : "Pink and healthy", + "averageIntraocularPressure" : "12" + }, + "right" : { + "visualField" : "normal", + "cdRatio" : 0.3, + "opticDiscAppearance" : "Pink and healthy", + "averageIntraocularPressure" : "12" + } + }, + "cycloplegicRefraction" : true, + "dilatedFundusExamination" : true, + "additionalInformation" : "Patient has accessibility needs", + "pmsWebhookCallback" : "http://example.com" +} +Schema +Collapse all Expand all +Name Description + +object + +Referral + +The referral to be created + + + +urgent +string + +Allowed values: notUrgent, urgent, emergencyASAP, emergency24Hours + + +dateOfSightTest +string date + + +A date in ISO 8601 compliant format + +Example: 2019-08-24 + + +dateOfReferral +string date + + +A date in ISO 8601 compliant format + +Example: 2019-08-24 + + +reasonForReferral +string + +Example: Needs assessment for cataract surgery + + +patient +object + + +guardian +object + + +referrer +object + +Referrer + + +GP +object + + +GPAction +string + +Allowed values: informationOnly, adviseReferralToEyeDept, patientSentToCasualty, patientAskedToTelephoneOrVisitGP + + +referTo +object + + +refraction +object + +VisionTest + + +additionalClinicalFindings +object + + +cycloplegicRefraction +boolean + + +dilatedFundusExamination +boolean + + +additionalInformation +string + +Example: Patient has accessibility needs + + +pmsWebhookCallback +string uri + + +Placeholder for callback API + +Example: http://example.com +Response +HTTP status: 201 + +Created + +Headers +Name Description +Accept-Version + +String + +The version number of the API you wish to call. + +Example: 1.0.0 + +Body + +Content type: application/json + +Example + +Copy +{ + "referralID" : "123e4567-e89b-12d3-a456-426614174000", + "referralURL" : "https://someEeRSSystem/referrals/123e4567-e89b-12d3-a456-426614174000", + "referralStatus" : "incomplete" +} +Schema +Collapse all Expand all +Name Description + +object + +Response + + +referralID +string + + +The unique, system-agnostic identifier of the referral. Must be an RCF 4122 compliant UUID. Only returned for a response of 201 CREATED + + + +referralURL +string + + +The EeRS URL the user should be redirected to for viewing the created referral. Only returned for a response of 201 CREATED + + + +referralStatus +string + + +The status of the referral in EeRS. Only returned for a response of 201 CREATED + + + +errorMessage +string + + +For responses other than 201 CREATED an error message will be populated + + + +errorCode +string + + +For responses other than 201 CREATED an error code will be populated + +HTTP status: 500 + +Internal Server Error + +HTTP status: 4XX + +An error occurred as follows: + +HTTP status errorMessage errorCode Scenario +400 Malformed JSON E0001 JSON could not be parsed for processing. It is invalid. +400 Empty JSON body E0002 No JSON was received in the request body. +400 A null value was submitted in one or more required fields. The fields are [insert field list]. E0008 No value was submitted in a mandatory field. +401 Authentication failed E0010 Either the API-KEY is invalid or the values in the ODS and GOCNumber fields failed authentication. +422 ODS Code Invalid E0006 ODS Code supplied not matched in EeRS system.For example, the formatting may not be valid, or it may not have matched a record in the register of ODSCodes held in the receiving system. +422 Registrant Number invalid E0007 The value supplied in the RegistrantNumber field is not valid as defined by the receiving system. For example, the formatting may not be valid, or it may not have matched a record in the register of GOC and GMC numbers held in the receiving system. +422 A data type could not be converted E0009 This error is used when the conversion to the target data type cannot be made. +Headers +Name Description +Accept-Version + +String + +The version number of the API you wish to call. + +Body + +Content type: application/json + +Example + +Copy +{ + "errorMessage" : "Malformed JSON", + "errorCode" : "E0001" +} +Schema +Collapse all Expand all +Name Description + +object + +Response + + +referralID +string + + +The unique, system-agnostic identifier of the referral. Must be an RCF 4122 compliant UUID. Only returned for a response of 201 CREATED + + + +referralURL +string + + +The EeRS URL the user should be redirected to for viewing the created referral. Only returned for a response of 201 CREATED + + + +referralStatus +string + + +The status of the referral in EeRS. Only returned for a response of 201 CREATED + + + +errorMessage +string + + +For responses other than 201 CREATED an error message will be populated + + + +errorCode +string + + +For responses other than 201 CREATED an error code will be populated + +Get referral status +GET /referral/{referralID}/status +Try this API + +Returns the status of the referral with the given ID A status update can be initiated by a clinician or admin, or set to be initiated automatically for all referrals as desired. + +Step 1: PMS system requests a status check to a specific referral ID using the same API key as for the referral + +Step 2: EeRS supplier provides response 200 with the status - or an error message + +Request +Path parameters +Name Description +referralID + +String + +The unique, system-agnostic identifier of the referral. Must be an RCF 4122 compliant UUID. + +Example: 123e4567-e89b-12d3-a456-426614174000 + +Required +Headers +Name Description +Accept-Version + +String + +The version number of the API you wish to call. + +Example: 1.0.0 + + +api-key + +String + +The API Key associated with the calling API consumer. + +Example: KdsASD78FA5Sjl342kfwreas + +Response +HTTP status: 200 + +OK + +Headers +Name Description +Accept-Version + +String + +The version number of the API you wish to invoke. + +Example: 1.0.0 + +Body + +Content type: application/json + +Example + +Copy +{ + "referralStatus" : "incomplete" +} +Schema +Collapse all Expand all +Name Description + +object + +StatusResponse + + +referralStatus +string + + +Shows the current status of the referral which will be one of: + +incomplete - the referral has been received in the EeRS system but has not yet not been closed or submitted. +submitted - the referral has been submitted to a provider for onward care. +closednotsubmitted - the referral has been closed by the user without being submitted for any further review or action by service providers e.g. because a clinician decided that a referral wasn't necessary. +printed - the referral was entered manually. Only populated for 200 SUCCESS response. +Allowed values: incomplete, submitted, closednotsubmitted, printed + + +errorMessage +string + + +For responses other than 200 SUCCESS an error message will be populated. + + + +errorCode +string + + +For responses other than 200 SUCCESS an error code will be populated. + +HTTP status: 400 + +Bad Request + +Headers +Name Description +Accept-Version + +String + +The version number of the API you invoked. + +Body + +Content type: application/json + +Example + +Copy +{ + "errorMessage" : "The request was malformed and couldn't be processed", + "errorCode" : "E0001" +} +Schema +Collapse all Expand all +Name Description + +object + +StatusResponse + + +referralStatus +string + + +Shows the current status of the referral which will be one of: + +incomplete - the referral has been received in the EeRS system but has not yet not been closed or submitted. +submitted - the referral has been submitted to a provider for onward care. +closednotsubmitted - the referral has been closed by the user without being submitted for any further review or action by service providers e.g. because a clinician decided that a referral wasn't necessary. +printed - the referral was entered manually. Only populated for 200 SUCCESS response. +Allowed values: incomplete, submitted, closednotsubmitted, printed + + +errorMessage +string + + +For responses other than 200 SUCCESS an error message will be populated. + + + +errorCode +string + + +For responses other than 200 SUCCESS an error code will be populated. + +HTTP status: 401 + +Unauthorized + +Headers +Name Description +Accept-Version + +String + +The version number of the API you invoked. + +Body + +Content type: application/json + +Example + +Copy +{ + "errorMessage" : "The API-KEY is invalid", + "errorCode" : "E0010" +} +Schema +Collapse all Expand all +Name Description + +object + +StatusResponse + + +referralStatus +string + + +Shows the current status of the referral which will be one of: + +incomplete - the referral has been received in the EeRS system but has not yet not been closed or submitted. +submitted - the referral has been submitted to a provider for onward care. +closednotsubmitted - the referral has been closed by the user without being submitted for any further review or action by service providers e.g. because a clinician decided that a referral wasn't necessary. +printed - the referral was entered manually. Only populated for 200 SUCCESS response. +Allowed values: incomplete, submitted, closednotsubmitted, printed + + +errorMessage +string + + +For responses other than 200 SUCCESS an error message will be populated. + + + +errorCode +string + + +For responses other than 200 SUCCESS an error code will be populated. + +HTTP status: 404 + +Referral with given ID not found + +Headers +Name Description +Accept-Version + +String + +The version number of the API you invoked. + +Body + +Content type: application/json + +Example + +Copy +{ + "errorMessage" : "ReferralID cannot be found by the receiving system", + "errorCode" : "E0005" +} +Schema +Collapse all Expand all +Name Description + +object + +StatusResponse + + +referralStatus +string + + +Shows the current status of the referral which will be one of: + +incomplete - the referral has been received in the EeRS system but has not yet not been closed or submitted. +submitted - the referral has been submitted to a provider for onward care. +closednotsubmitted - the referral has been closed by the user without being submitted for any further review or action by service providers e.g. because a clinician decided that a referral wasn't necessary. +printed - the referral was entered manually. Only populated for 200 SUCCESS response. +Allowed values: incomplete, submitted, closednotsubmitted, printed + + +errorMessage +string + + +For responses other than 200 SUCCESS an error message will be populated. + + + +errorCode +string + + +For responses other than 200 SUCCESS an error code will be populated. + +HTTP status: 500 + +Internal Server Error + +Last edited: 1 September 2022 11:44 am \ No newline at end of file diff --git a/baselineTexts/female-genital-mutilation-enhanced-dataset.txt b/baselineTexts/female-genital-mutilation-enhanced-dataset.txt new file mode 100644 index 0000000..0a19215 --- /dev/null +++ b/baselineTexts/female-genital-mutilation-enhanced-dataset.txt @@ -0,0 +1,62 @@ +SCCI2026: Female Genital Mutilation Enhanced Dataset + +The FGM Enhanced Dataset requires organisations to record collect and return detailed information about FGM within the patient population, as treated by the NHS in England. + +Page contents +Top of page +About this information standard +Current release +About this information standard + +The FGM Enhanced Dataset requires organisations to record collect and return detailed information about FGM within the patient population, as treated by the NHS in England. This release introduces the Female Genital Mutilation (FGM) Enhanced Dataset, which supersedes the FGM Prevalence Dataset (ISB 1610). + +NHS Digital has been directed to collect the FGM Enhanced Dataset by the Department of Health (see link to right of page). NHS Digital has issued a Data Provision Notice to care providers to inform them of the requirement to submit this data. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the Requirements Specification and Implementation Guidance documents provide further detail for those who have to implement the information standard. + +This information standard uses SNOMED CT codes; the most up-to-date set of codes are available through the Data Dictionary for Care (external link). + +Update 24 September 2015:The current release (SCCI2026 Amd 12/2014) was published on 01 April 2015. As part of the HSCIC's implementation monitoring and support, the need for assistance and clarification in a number of areas has been identified by both users and suppliers. The Corrigendum dated 24-Sep-15 (see below) provides this in relation to: implementation dates; use in general practice; exempt clinical settings and clinical terminology codes. A minor change to one data item is also noted. + +Update 20 April 2015:The current release (SCCI2026 Amd 12/2014) was published on 01 April 2015.  Since then an error has been identified, in relation to the data item FEMALE GENITAL MUTILATION IDENTIFICATION METHOD CODE. The Corrigendum dated 20-Apr-15 (see below) lists the error and the correction; this should be read alongside the Requirements Specification and Implementation Guidance. The corrigendum will be incorporated in the next release of this information standard. + +Note: A post-implementation review (PIR) of the Initial Standard was conducted between November 2015 and March 2016; details of the review findings were provided in a report which was presented to SCCI in June 2016. Find out more about the PIR and view the report.. + +Current release +Release date 01/04/2015 +Release number Amd 12/2014 +Release title Initial Standard +Stage Implementation +Key documents +Requirements Specification (Amd 12/2014) [Archive Content] +Implementation Guidance (Amd 12/2014) [Archive Content] +Information Standards Notice (Amd 12/2014) +Corrigendum 20-Apr-15 (Amd 12/2014) +Corrigendum 24-Sep-15 (Amd 12/2014) +NHS Data Model and Dictionary Change Request 1554 (Amd 12/2014) + +Supporting documents +Implementation Guidance Summary (Amd 12/2014) +NHS Data Model and Dictionary Change Request 1494 (Amd 12/2014) +SNOMED CT codes via the Data Dictionary for Care + +Guidance - Issued Sep 15 +FGM Enhanced Dataset - GP Approach v1.0 (Amd 12/2014) +FGM Prevention Programme: Understanding the FGM Enhanced Dataset - updated guidance and clarification to support implementation (Amd 12/2014) + +Further information   NHS Digital FGM + +ISB 1610 Female Genital Mutilation Prevalence Dataset + +This information standard has been superseded by the FGM Enhanced Dataset (see above), + +Retirement date 10/04/2015 +Key documents +Information Standards Notice (Retirement) +NHS Data Model and Dictionary Change Request 1506 + +Further information NHS Digital FGM + +  + +Last edited: 5 November 2018 12:26 pm \ No newline at end of file diff --git a/baselineTexts/female-genital-mutilation-information-sharing-smsp-api-standards.txt b/baselineTexts/female-genital-mutilation-information-sharing-smsp-api-standards.txt new file mode 100644 index 0000000..d269e14 --- /dev/null +++ b/baselineTexts/female-genital-mutilation-information-sharing-smsp-api-standards.txt @@ -0,0 +1,129 @@ +Female Genital Mutilation - Information Sharing - SMSP API standards + +Become a Spine Mini Service Provider giving access to female genital mutilation (FGM) information for children under 18 to relevant NHS professionals across England, using our Female Genital Mutilation - Information Sharing (FGM-IS) SMSP API standards. + +Page contents +Top of page +Overview +Who can use this API +Related APIs +API status +Technology +Network access +Security and authorisation +Environments and testing +Onboarding +Interactions +Downloads +Overview + +Become a Spine Mini Service Provider giving access to female genital mutilation (FGM) information for children under 18 to relevant NHS professionals across England, using our Female Genital Mutilation - Information Sharing (FGM-IS) SMSP API standards. + +Your commercially available Spine Mini Service Providers (SMSP) product will give access to FGM-IS for your SMSP clients. We will list your SMSP provider service along with other conforming software products in our Conformance Catalogue. + +Before you begin any development work using these API standards, contact us to discuss your best options. + +Note your SMSP clients can only: + +query a patient's FGM status + +In addition to SMSP provider software assurance, we also need to assure your SMSP clients. + +For more details, see Introduction to the FGM Information Sharing Service. + +Who can use this API + +These API standards can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. + +You must do this before you can go live (see ‘Onboarding’ below).  + +Related APIs + +The following APIs are related to these API standards: + +Personal Demographics Service - FHIR API - use this to find the correct NHS number for a given patient +Female Genital Mutilation - Information Sharing - FHIR API - use this for the full features of our FHIR API +API status + +These API standards are in beta. + +Technology + +These API standards are based on our FGM - IS - FHIR API but with a simplified read-only model. + +Specifically, they are based on the HL7 FHIR DSTU2 1.0.1 Messaging Implementation. + +For more details, see FHIR. + +Network access + +You need a Health and Social Care Network (HSCN) connection to use these API standards. + +For more details, see Network access for APIs. + +Security and authorisation + +These API standards are application-restricted, meaning the calling application is authenticated but the end user is either not authenticated or not present. + +In particular, these API standards use TLS-MA authentication. + +For more details on authentication, see application-restricted APIs. + +Even though these API standards do not technically require the end user to be authenticated, a condition of onboarding is that the calling application must: + +authenticate the end user locally +use local role-based access controls to authorise the end user +Environments and testing + +You can test these API standards using our Path to Live environments. + +Onboarding + +You must get your software onboarded before it can go live. + +As part of onboarding, these API standards use a slightly scaled down version of the Common Assurance Process (CAP) which involves a Target Operating Model (TOM) form for the transfer of risk.  + +Note that in addition to SMSP provider software assurance, for clinical safety reasons, we also need to assure your SMSP clients. + +For more details, and to get a copy of the latest TOM forms to complete, contact the interoperability conformance team on itkconformance@nhs.net. + +Interactions + +For details of SMSP provider interactions, see the following downloads: + +SMSP Common Provider Requirements V1.0 - 12/05/2017 PDF +FGM-IS SMSP Provider Requirements 1.0.1 - 24/04/2020 PDF + +For details of SMSP client interactions, to share with your clients, see the following downloads: + +SMSP Common Client Requirements V1.0 - 12/05/2017 PDF +FGM-IS Client Requirements V2.0.1 - 04/06/2020 + +Both SMSP providers and SMSP clients need the same response codes: + +SMSP Response Codes - 24/07/2014 XLS +Downloads + +These are PDF and Microsoft Excel files. To request a different format, contact us. + +SMSP Common Provider Requirements V1.0 - 12/05/2017 PDF + +PDF 610 KB + +FGM-IS SMSP Provider Requirements 1.0.1 - 24/04/2020 PDF + +PDF 280 KB + +SMSP Common Client Requirements V1.0 - 12/05/2017 PDF + +PDF 503 KB + +FGM-IS Client Requirements V2.0.1 - 04/06/2020 + +PDF 276 KB + +SMSP Response Codes - 24/07/2014 XLS + +XLSX 17 KB + +Last edited: 26 May 2022 3:25 pm \ No newline at end of file diff --git a/baselineTexts/gp-connect-access-document-fhir-api.txt b/baselineTexts/gp-connect-access-document-fhir-api.txt index c6aa06a..f264f9a 100644 --- a/baselineTexts/gp-connect-access-document-fhir-api.txt +++ b/baselineTexts/gp-connect-access-document-fhir-api.txt @@ -33,7 +33,7 @@ Who can use this API This API can be used by developers of clinical systems that support clinicians delivering direct care. -Before you start development, read the GP Connect API 1.5.0-beta specification and the prerequisites listed below.   +Before you start development, read the GP Connect API 1.5.1-beta specification and the prerequisites listed below.   Prerequisites Technical @@ -66,7 +66,7 @@ Personal Demographics Service - FHIR API  – use this API to look up the regi Spine Directory Service - FHIR API  – access accredited system information and messaging endpoint details API status -The current working version is 1.5.0, which is in beta and available to all consumers, subject to an approved use case and onboarding process. As well as medications and allergies, version 1.5.0 includes the majority of the clinical record. +The current working version is 1.5.1, which is in beta and available to all consumers, subject to an approved use case and onboarding process. As well as medications and allergies, version 1.5.1 includes the majority of the clinical record. It also includes the ability to access deceased patients' documents. It does not include: @@ -79,9 +79,11 @@ Read the specification for the exact details. It may not be fully supported by all providing systems. See GP Connect supplier progress for details of provider rollout. +The previous version (1.5.0) does not include the ability to access deceased patients' documents, but is available for system suppliers who have started to develop against it. + Roadmap -The next planned version is 1.6.0, which is currently in beta. The 1.6.0 specification contains the full scope of 1.5.0, but additionally it introduces a new message to support GP2GP transactions. It is important to understand that the GP2GP transactions do not affect the consumer build. 1.6.0 will be backward compatible with the 1.5.0 specification. +The next planned version is 1.6.0, which is currently in beta. The 1.6.0 specification contains the full scope of 1.5.0, but additionally it introduces a new message to support GP2GP transactions. It is important to understand that the GP2GP transactions do not affect the consumer build. 1.6.0 will be backward compatible with the 1.5.1 specification. Service level @@ -202,7 +204,7 @@ For more information, see Clinical assurance process details. Interactions -For a full list of interactions for this API, see GP Connect API v1.5.0-beta – which contains Access Document. +For a full list of interactions for this API, see GP Connect API v1.5.1-beta – which contains Access Document. For details on the general structure of the interactions, see FHIR. @@ -228,4 +230,4 @@ Hazard log The GP Connect Access Record: Structured generic hazard log shows you the clinical risks of using GP Connect functionality through a consumer system. Use it to identify the clinical risks of consuming clinical data and presenting it in your system, and record these in your own system-specific hazard log. If necessary, take mitigating action to ensure clinical safety. -Last edited: 27 May 2022 8:13 pm \ No newline at end of file +Last edited: 22 June 2022 3:42 pm \ No newline at end of file diff --git a/baselineTexts/gp-connect-access-record-html-fhir-api.txt b/baselineTexts/gp-connect-access-record-html-fhir-api.txt index 9a649e7..0599acc 100644 --- a/baselineTexts/gp-connect-access-record-html-fhir-api.txt +++ b/baselineTexts/gp-connect-access-record-html-fhir-api.txt @@ -36,7 +36,7 @@ Who can use this API This API can be used by developers of clinical systems that support clinicians delivering direct care. -Before you start development, read the GP Connect API v0.7.3 specification and the prerequisites listed below.   +Before you start development, read the GP Connect API v0.7.4 specification and the prerequisites listed below.   Prerequisites Technical @@ -69,7 +69,7 @@ Personal Demographics Service - FHIR API  – use this API to look up the regi Spine Directory Service - FHIR API  – access accredited system information and messaging endpoint details API status -This API (v0.7.3) is stable. +This API (v0.7.4) is in production. It might not be fully supported by all providing systems. See GP Connect supplier progress for details of provider rollout. @@ -154,8 +154,8 @@ Start your development work within 6 months of use case approval. If you miss t Interactions -For a full list of interactions for this API, see GP Connect API v0.7.3. +For a full list of interactions for this API, see GP Connect API v0.7.4. For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 4:15 pm \ No newline at end of file +Last edited: 13 October 2022 5:46 pm \ No newline at end of file diff --git a/baselineTexts/gp-connect-access-record-structured-fhir-api.txt b/baselineTexts/gp-connect-access-record-structured-fhir-api.txt index 0cc9e47..b741952 100644 --- a/baselineTexts/gp-connect-access-record-structured-fhir-api.txt +++ b/baselineTexts/gp-connect-access-record-structured-fhir-api.txt @@ -58,13 +58,11 @@ Retrieving documents To retrieve documents from a patient’s registered GP practice, use GP Connect Access Document - FHIR API. After you've found the relevant document references within Access Record returns, use GP Connect Access Document to retrieve the documents. All documents can be requested separately. -For more details, see the Access Document part of the Access Record: Structured specification. - Who can use this API This API can be used by developers of clinical systems that support clinicians delivering direct care. -Before you start development, read the GP Connect API 1.5.0-beta specification and the prerequisites listed below.   +Before you start development, read the GP Connect API 1.5.1-beta specification and the prerequisites listed below.   Prerequisites Technical @@ -100,7 +98,7 @@ Personal Demographics Service - HL7 V3 API  – use this if you want to use f Spine Directory Service - FHIR API  – access accredited system information and messaging endpoint details API status and roadmap -The current working version is 1.5.0, which is in beta and available to all consumers, subject to an approved use case and onboarding process. As well as medications and allergies, version 1.5.0 includes the majority of the clinical record. +The current working version is 1.5.1, which is in beta and available to all consumers, subject to an approved use case and onboarding process. As well as medications and allergies, version 1.5.1 includes the majority of the clinical record. It also includes the ability to access deceased patients' documents. It does not include: @@ -109,13 +107,15 @@ flags and alerts templates test requests -Read the specification for the exact details. +Read the specification for the exact details. + +It may not be fully supported by all providing systems. See GP Connect supplier progress for details of provider rollout. -It may not be fully supported by all providing systems. See GP Connect supplier progress for details of provider rollout. +The previous version (1.5.0) does not include the ability to access deceased patients' documents, but is available for system suppliers who have started to develop against it. Roadmap -The next planned version is 1.6.0, which is currently in beta. The 1.6.0 specification contains the full scope of 1.5.0, but additionally it introduces a new message to support GP2GP transactions. It is important to understand that the GP2GP transactions do not affect the consumer build. 1.6.0 will be backward compatible with the 1.5.0 specification. +The next planned version is 1.6.0, which is currently in beta. The 1.6.0 specification contains the full scope of 1.5.1, but additionally it introduces a new message to support GP2GP transactions. It is important to understand that the GP2GP transactions do not affect the consumer build. 1.6.0 will be backward compatible with the 1.5.1 specification. Service level @@ -234,7 +234,7 @@ For more information, see Clinical assurance process details. Interactions -For a full list of interactions for this API, see GP Connect API v1.5.0-beta, which contains Access Record: Structured. +For a full list of interactions for this API, see GP Connect API v1.5.1-beta, which contains Access Record: Structured. For details on the general structure of the interactions, see FHIR. @@ -260,4 +260,4 @@ Hazard log The GP Connect Access Record: Structured generic hazard log shows you the clinical risks of using GP Connect functionality through a consumer system. Use it to identify the clinical risks of consuming clinical data and presenting it in your system, and record these in your own system-specific hazard log. If necessary, take mitigating action to ensure clinical safety. -Last edited: 26 May 2022 3:28 pm \ No newline at end of file +Last edited: 24 June 2022 11:04 am \ No newline at end of file diff --git a/baselineTexts/gp-connect-send-document-fhir-api.txt b/baselineTexts/gp-connect-send-document-fhir-api.txt index 3255ac2..5f79308 100644 --- a/baselineTexts/gp-connect-send-document-fhir-api.txt +++ b/baselineTexts/gp-connect-send-document-fhir-api.txt @@ -1,13 +1,13 @@ -GP Connect Send Document - FHIR API +GP Connect Send Document - FHIR Send a PDF consultation summary to a registered GP practice. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -16,8 +16,15 @@ Environments and testing Onboarding Interactions Overview +Point-of-care application +MESH +Patient's  registered GP system +send  consultation summary +receive consultation summary -Use this API to send a PDF consultation summary to a registered GP practice - using GP Connect Messaging. +  + +Use this integration to send a PDF consultation summary to a registered GP practice - using GP Connect Messaging. For example, use it to send a document containing a patient's consultation notes to their GP practice when a patient is seen: @@ -25,17 +32,17 @@ at another GP practice than their own by an out of hours service by a district nurse at home -Each message sent using this API uses the GP Connect Messaging components, MESH, and ITK3, to deliver the message. +Each message sent using this integration uses the GP Connect Messaging components, MESH, and ITK3, to deliver the message. Each message sent is a FHIR Message, defined as a FHIR composition, constructed to meet the ITK3 standard with a specific payload structure. For more details, see the GP Connect specifications for developers. -Who can use this API +Who can use this -This API can be used by developers of clinical systems that support clinicians delivering direct care. +This integration can be used by developers of clinical systems that support clinicians delivering direct care. -Before you start development, read the Send Document section of the GP Connect API 1.5.1-beta messaging specification and the prerequisites listed below.   +Before you start development, read the Send Document Implementation Guide.   Prerequisites Technical @@ -63,36 +70,34 @@ If you are confident that you can meet the prerequisites, contact us to express Related APIs -The following APIs and API standards are also related to this API: +The following APIs and API standards are also related to this integration: Personal Demographics Service - FHIR API  – use this API to look up the registered GP for the patient Message Exchange for Social Care and Health (MESH) API - transfer messages and large files securely across health and social care organisations Interoperability Toolkit 3 Messaging Distribution FHIR API standards - define a set of generic messaging components using FHIR STU3 -API status +Status -This API (v1.5.1) is in beta. +This integration is in production. It might not be fully supported by all providing systems. See GP Connect supplier progress for details of provider rollout. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. - -It sends HL7 FHIR STU3 message payloads over MESH as defined by ITK3 v2.10.0. +This integration sends HL7 FHIR STU3 message payloads over MESH as defined by ITK3 v2.10.0. For more details, see FHIR. Network access -You can access this API via: +You can access this integration via: the Health and Social Care Network (HSCN) the internet @@ -101,9 +106,9 @@ the internet Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -The API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. +The integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. Environments and testing @@ -132,8 +137,8 @@ Once we receive your use case, we'll respond within 14 days. Interactions -For a full list of interactions for this API, see Send Document. +For a full list of interactions for this integration, see the latest supported version. For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 3:30 pm \ No newline at end of file +Last edited: 13 October 2022 6:09 pm \ No newline at end of file diff --git a/baselineTexts/gp2gp-hl7-v3-api.txt b/baselineTexts/gp2gp-hl7-v3-api.txt index 2fda304..1e59f49 100644 --- a/baselineTexts/gp2gp-hl7-v3-api.txt +++ b/baselineTexts/gp2gp-hl7-v3-api.txt @@ -1,13 +1,13 @@ -GP2GP - HL7 V3 API +GP2GP - HL7 V3 Transfer patients' electronic health records, securely and quickly, between their old and new practices when they change GPs. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -18,7 +18,7 @@ Interactions Additional guidance Overview -Use this API to transfer patients' electronic health records between old and new practices when they change GPs. +Use this integration to transfer patients' electronic health records between old and new practices when they change GPs. You can: @@ -30,15 +30,15 @@ monitor in real time the processes to track issues and performance For more details, see GP2GP. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below).  Related APIs -The following APIs are related to this one: +The following APIs are related to this integration: Personal Demographics Service - FHIR API - use this new API to search for patients, retrieve patients by NHS number and update patients. Personal Demographics Service - HL7 V3 API - use this if you want to use functions that are not yet available on the FHIR API. @@ -48,19 +48,19 @@ NHAIS GP Links API - use this to manage GP registrations and other patient data Organisation Data Service - FHIR API - use this to search a national repository of NHS Organisation Reference Data using a FHIR interface. Organisation Data Service - ORD API - use this to search a national repository of NHS Organisation Reference Data using an ORD interface. Messaging Exchange for Social care and Health (MESH) - use this component of the Spine to deliver messages and files to registered recipients, in this case, to send audit information. -API status +Status -This API is stable. +This integration is in production. Service level -This API is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is an HL7 V3 API. +This integration is an HL7 V3 integration. For more details, see HL7 V3. @@ -68,18 +68,18 @@ Message Handling System (MHS) adaptor To remove the complexity of building your own Message Handling System, we offer a pre-assured, client side MHS adaptor that you can integrate into your own infrastructure. -It makes it easier to connect to the NHS Spine and perform business operations by exposing a RESTful API that confirms to the HL7 V3 standard.  +It makes it easier to connect to the NHS Spine and perform business operations by exposing a RESTful API that conforms to the HL7 V3 standard.  Network access -You need a Health and Social Care Network (HSCN) connection to use this API. +You need a Health and Social Care Network (HSCN) connection to use this integration. For more details, see Network access for APIs. Security and authorisation Authentication -This API is user-restricted, meaning an end user must be present and authenticated to use it. +This integration is user-restricted, meaning an end user must be present and authenticated to use it. The end user must be: @@ -92,23 +92,23 @@ Authorisation For some activities, the end user must be authorised to perform that activity. -The API itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +The integration itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. Testing -You can test this API using our Path to Live environments. +You can test this integration using our Path to Live environments. Onboarding You must get your software onboarded before it can go live. -Contact us before onboarding with this API. It uses the Common Assurance Process (CAP) which is tailored for each NHS service. +Contact us before onboarding with this integration. It uses the Common Assurance Process (CAP) which is tailored for each NHS service. Interactions -For a full list of interactions for this API, see the GP2GP domain in the Spine Message Implementation Manual (MIM). +For a full list of interactions for this integration, see the GP2GP domain in the Spine Message Implementation Manual (MIM). For details on the general structure of the interactions, see HL7 V3. @@ -116,4 +116,4 @@ Additional guidance For more details about requirements and specifications of the record transfer mechanism, see the GP2GP section in the GP IT Futures Capabilities and Standards guidance. -Last edited: 26 May 2022 4:17 pm \ No newline at end of file +Last edited: 13 October 2022 5:42 pm \ No newline at end of file diff --git a/baselineTexts/gumcad-sti-surveillance-system.txt b/baselineTexts/gumcad-sti-surveillance-system.txt new file mode 100644 index 0000000..de15b30 --- /dev/null +++ b/baselineTexts/gumcad-sti-surveillance-system.txt @@ -0,0 +1,48 @@ +DCB0139: GUMCAD STI Surveillance System + +GUMCAD (Genitourinary Medicine Clinic Activity Dataset) is the mandatory surveillance system for sexually transmitted infections (STIs) in England. + +Page contents +Top of page +About this information standard +Current release +About this information standard + +The GUMCAD STI Surveillance System is the new name for the Genitourinary Medicine Clinic Activity Dataset (GUMCAD). + +It is a mandatory reporting system providing data on sexual health services and STI diagnoses from all commissioned Level 3 and Level 2 sexual health services in England. + +GUMCAD data are primarily collected to monitor trends in STI diagnoses, to identify inequalities in sexual health, and to measure the success or impact of service delivery. + +Public Health England (PHE) co-ordinates and manages this quarterly data collection; processing, storage and analysis on behalf of the Department of Health and Social Care (DHSC). Data are: + +reported quarterly to service providers and local authority commissioners +used for the chlamydia detection rate (1 of only 3 sexual health indicators on the Public Health Outcomes Framework) +published annually as official statistics. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standard. + +Update 10 December 2019: The current release of DCB0139 GUMCAD STI Surveillance System was published on 25 June 2018, with a full conformance date of 1 April 2019. Since then the need for a minor change to the data set has been identified and a corrigendum has been published (see below) alongside an updated Information Standards Notice. The data set needs to be changed to add a new national code of “180 tablets” to the following attribute in the NHS Data Model and Dictionary: PRESCRIBED ITEM QUANTITIES FOR PRE EXPOSURE PROPHYLAXIS + +Current release +Release date 25 June 2018 +Release number Amd 21/2017 +Stage Implementation +Key documents +Change specification (Amd 21/2017) +Requirements specification (Amd 21/2017) [Archive Content] +Implementation guidance (Amd 21/2017) +Information Standards Notice Version 2 (Amd 21/2017) +Information Standards Notice (Superseded) (Amd 21/2017) +Corrigendum (Amd 21/2017) + +Supporting documents +NHS Data Model and Dictionary Change Request 1618 (Basic CR) (Amd 21/2017)  +NHS Data Model and Dictionary Change Request 1618 (Data Set CR) (Amd 21/2017) +NHS Data Model and Dictionary Change Request 1746 (Amd 21/2017 Corrigendum) + +Further information + +Please see the ISB website for information on the previous releases. + +Last edited: 11 January 2022 8:11 am \ No newline at end of file diff --git a/baselineTexts/health-and-social-care-organisation-reference-data.txt b/baselineTexts/health-and-social-care-organisation-reference-data.txt index d4bf4d8..e052864 100644 --- a/baselineTexts/health-and-social-care-organisation-reference-data.txt +++ b/baselineTexts/health-and-social-care-organisation-reference-data.txt @@ -1,28 +1,40 @@ -DCB0090: Health and Social Care Organisation Reference Data +DAPB0090: Health and Social Care Organisation Reference Data The information standard provides reference data about the Organisations that comprise the health and social care services, including non-direct-care Organisations, primarily in England but also in the other UK-constituent countries. Page contents Top of page About this information standard -Current Release -Previous release +Current release +Previous releases +Updates About this information standard -This information standard provides reference data about the Organisations that comprise the health and social care services, including non-direct-care Organisations, primarily in England but also in the other UK-constituent countries. +This information standard provides reference data about the Organisations that comprise the health and social care services, including non-direct-care Organisations, primarily in England but also in the other UK-constituent countries. The data is distributed and uploaded to health IT systems. It supports user security, access control, messaging and is used as reference data for both operations and reporting. -The current release, published on 8 March 2018, introduces a new delivery mechanism for weekly/daily updates of the reference data. Instead of data having to be obtained via NHS Digital's Technology Reference data Update Distribution (TRUD) service, an Application Programming Interface (API) has been developed to allow customers direct access to updates. This will go live by the end of April 2018. +This information standard is published under Section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales. -This information standard is published under Section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the Specification and Implementation Documents provide further detail for those who have to implement the information standard. +Current release +Release date 08/06/2022 +Release number Amd 25/2022 +Release title Version 1.2 +Stage Implementation +Key documents +Information Standards Notice (Amd 25/2022) + +No additional documents (Requirements Specification, Implementation guidance etc.) have been published as part of this release. This ISN should be read in conjunction with the ISN for the previous release of this information standard (DCB0090 Amd 81/2017) and the content via 'Further information'.  -Update: October 2020:  Following a pause, the new ANANA code format has now formally come into use for all new code requests. New code requests will be given an ANANA code with a structure of 5 alternating alphabetic and numeric characters e.g. G7H8J. This means it will no longer be possible to identify the type of organisation from the way it is structured. Detailed guidance on this change is available on the ODS website. -Update - January 2021: The NHS Business Services Authority (NHS BSA) has recently introduced a 7 character code for all new dental practices. As this reference data is published by the ODS, a decision has been taken to adopt the same 7 character code format for all new dental practices from February 2021. The majority of practices that are already coded as 6 characters will remain the same;  however a small number of practices will need to migrate over to the new 7 character code. A test file containing the new dental practice codes is now available from the data downloads page.   +Supporting documents +NHS Data Model and Dictionary Change Request 1846 (Amd 25/2022) -Current Release +Further Information +Integrated Care Boards (ICBs) in ODS data, published by NHS Digital +Integrated Care Boards in England, published by NHS England and NHS Improvement +Previous releases +Version 1.1 Release date 08/03/2018 Release number Amd 81/2017 -Release title Version 1.1 Stage Maintenance Key documents Change Specification, 8 March 2018 (Amd 81/2017) @@ -35,12 +47,13 @@ NHS Data Model and Dictionary Change Request 1638 (Amd 81/2017) Full Business Justification (Amd 81/2017) Management Summary (Amd 81/2017) -Further Information Organisation Data Service -Previous release +  + +Version 1.0 Release date 17/08/2016 Release number Amd 24/2015 Release title Fundamental Standard: Initial Release -Stage Maintenance +Stage Superseded by Amd 81/2017 Key documents Requirement Specification (Amd 24/2015) Implementation Plan and Guidance 11 (Amd 24/2015) @@ -51,5 +64,12 @@ Supporting documents NHS Data Model and Dictionary Change Request 1532 (Amd 24/2015) Full Business Justification (Amd 24/2015) Management Summary (Amd 24/2015) +Updates + +January 2021: The NHS Business Services Authority (NHS BSA) has recently introduced a 7 character code for all new dental practices. As this reference data is published by the ODS, a decision has been taken to adopt the same 7 character code format for all new dental practices from February 2021. The majority of practices that are already coded as 6 characters will remain the same;  however a small number of practices will need to migrate over to the new 7 character code. A test file containing the new dental practice codes is now available from the data downloads page.   + +October 2020:  Following a pause, the new ANANA code format has now formally come into use for all new code requests. New code requests will be given an ANANA code with a structure of 5 alternating alphabetic and numeric characters e.g. G7H8J. This means it will no longer be possible to identify the type of organisation from the way it is structured. Detailed guidance on this change is available on the ODS website. + +  -Last edited: 12 July 2021 11:46 am \ No newline at end of file +Last edited: 8 June 2022 3:20 pm \ No newline at end of file diff --git a/baselineTexts/healthy-child-record.txt b/baselineTexts/healthy-child-record.txt index ae0f2e4..4ae3243 100644 --- a/baselineTexts/healthy-child-record.txt +++ b/baselineTexts/healthy-child-record.txt @@ -22,18 +22,22 @@ Institute of Health Records Information Management (IHRIM) TechUK Supported by: Clinical leadership was provided by the Royal College of Paediatrics and Child Health (RCPCH) and the Royal College of General Practitioners (RCGP). Work was conducted in partnership with the Royal College of Physicians (RCP) Health Informatics Unit (HIU). The standard + Healthy child standard specification + Current release – 08/10/2020 Release number – Amd 11/2020 + Information standards notice (ISN) The ISN informs service providers that the Healthy child record must be adopted and gives the time frame for doing this, along with the relevant guidance materials and previous releases. + Supporting documentation Implementation Guidance Section specific implementation guidance Healthy child record final report Information standards notice Clinical safety case report -Technical Specifications – Should local areas wish to share data in their region then this should be done as an electronic message. These are available on NHS Developer Network and will be updated as the development cycle continues (https://developer.nhs.uk/apis/dch-beta/). +Technical Specifications – Should local areas wish to share data in their region then this should be done as an electronic message. These are available on NHS Developer Network and will be updated as the development cycle continues. IHRIM record correction guidance Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. diff --git a/baselineTexts/hospital-referral-for-assessment-for-community-care-and-support.txt b/baselineTexts/hospital-referral-for-assessment-for-community-care-and-support.txt index b019937..bf6fcb9 100644 --- a/baselineTexts/hospital-referral-for-assessment-for-community-care-and-support.txt +++ b/baselineTexts/hospital-referral-for-assessment-for-community-care-and-support.txt @@ -33,6 +33,7 @@ Royal College of Nursing Royal College of Occupational Therapists Royal College of Physicians Royal Pharmaceutical Society +View the standard Hospital referral for assessment for community care and support v1.1 V1.1 View the standard V1.1 Download the standard (xlsx file) diff --git a/baselineTexts/improving-access-to-psychological-therapies-data-set.txt b/baselineTexts/improving-access-to-psychological-therapies-data-set.txt new file mode 100644 index 0000000..9f58595 --- /dev/null +++ b/baselineTexts/improving-access-to-psychological-therapies-data-set.txt @@ -0,0 +1,61 @@ +DAPB1520: Improving Access to Psychological Therapies Data Set + +The Improving Access to Psychological Therapies (IAPT) Data Set collects information about adults in contact with psychological therapy services. + +Page contents +Top of page +About this information standard +Current release +Change control +Previous releases +About this information standard + +This information standard provides national definitions for the collection of IAPT data, allowing providers to extract data from their local systems in a consistent manner which enables national and local reporting to be undertaken. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Version 2.1 +Release date 20/07/2021 +Release number Amd 13/2021 +Stage Implementation +Key documents  +Requirements Specification (Amd 13/2021) (October 2021) +Implementation Guidance (Amd 13/2021) (October 2021) +Change Specification (Amd 13/2021) (October 2021) +Technical Output Specification (TOS) (Amd 13/2021) +Information Standards Notice (Amd 13/2021) + +Supporting documents +NHS Data Model and Dictionary Change Request - 1818 (Basic CR) (Amd 13/2021) (October 2021) +NHS Data Model and Dictionary Change Request - 1818 (Data Set CR) (Amd 13/2021) (October 2021)  + +Further information  NHS Digital IAPT web pages +Change control + +Update 6 October 2021 + +At the time of publication of version 2.1 (20 July 2021), users were expected to fully conform with this standard by 25 March 2022. Due to continuing investment in COVID-19 activity, NHS Digital has since extended the implementation and conformance dates of this standard by three months. Full conformance is now expected with the submission of the April 2022 reporting activity by 29 June 2022. + +The Requirements Specification, Change Specification, and Implementation Guidance have been annotated to reflect this and the updated copies are available in the version 2.1 release table above. + +Previous releases +Version 2.0 +Release date 05/09/2019 +Release number Amd 14/2019 +Stage Maintenance +Key documents  +Requirements Specification (Amd 14/2019) +Implementation Guidance (Amd 14/2019) +Information Standards Notice (Amd 14/2019) +Corrigendum (Amd 14/2019) (October 2019) +Change Specification (Amd 14/2019) (October 2019) +Data Set Specification (Amd 14/2019) (October 2019) [Archive Content] + +Supporting documents +NHS Data Model and Dictionary Change Request - 1719 (Basic CR) (Amd 14/2019) (October 2019) +NHS Data Model and Dictionary Change Request - 1719 (Data Set CR) (Amd 14/2019) (October 2019) + +Documentation from previous releases are available on request from standards.assurance@nhs.net  + +Last edited: 8 October 2021 9:59 am \ No newline at end of file diff --git a/baselineTexts/information-provided-by-local-authorities-in-shared-care-records.txt b/baselineTexts/information-provided-by-local-authorities-in-shared-care-records.txt index 848b3d1..156f807 100644 --- a/baselineTexts/information-provided-by-local-authorities-in-shared-care-records.txt +++ b/baselineTexts/information-provided-by-local-authorities-in-shared-care-records.txt @@ -31,6 +31,7 @@ Royal College of Nursing Royal College of Occupational Therapists Royal College of Physicians Royal Pharmaceutical Society +View the standard Information provided by local authorities in shared care records v1.1 V1.1 View the standard V1.1 Download the standard (xlsx file) diff --git a/baselineTexts/information-sharing-to-tackle-violence.txt b/baselineTexts/information-sharing-to-tackle-violence.txt index 0f0fc5f..fed12e5 100644 --- a/baselineTexts/information-sharing-to-tackle-violence.txt +++ b/baselineTexts/information-sharing-to-tackle-violence.txt @@ -22,7 +22,7 @@ A Corrigendum, below, notes the closure of the ISTV Programme Board and the tr 2 April 2019 Update: -The implementation guidance for ISB 1594: Information Sharing to Tackle Violence Minimum Dataset has been updated; while no changes have been made to the content of the standard, the implementation guidance has been updated to reflect the introduction of the Data Protection Act 2018 (GDPR) and the owning organisation's branding guidelines. A formal review and update of the information standard and implementation guidance will be undertaken shortly.   +The implementation guidance for ISB 1594: Information Sharing to Tackle Violence Minimum Dataset has been updated [Archive Content]; while no changes have been made to the content of the standard, the implementation guidance has been updated to reflect the introduction of the Data Protection Act 2018 (GDPR) and the owning organisation's branding guidelines. A formal review and update of the information standard and implementation guidance will be undertaken shortly.     @@ -32,12 +32,12 @@ Release name Amd 31/2012 Release title Initial Standard Stage  Maintenance Key documents -Information Standards Notice (Amd 31/2012) -Specification (Amd 31/2012) -Guidance (Amd 31/2012) (Version 2.1, April 2019) +Information Standards Notice (Amd 31/2012) [Archive Content] +Specification (Amd 31/2012) [Archive Content] +Guidance (Amd 31/2012) [Archive Content] (Version 2.1, April 2019) Corrigendum (Amd 31/2012) -Supporting documents  NHS Data Model and Dictionary Change Request 1344 (Amd 31/2012) +Supporting documents  NHS Data Model and Dictionary Change Request 1344 (Amd 31/2012) [Archive Content] Further information Information Sharing to Tackle Violence guidance for Community Safety Partnerships (CSPs). Last edited: 25 November 2021 1:52 pm \ No newline at end of file diff --git a/baselineTexts/international-statistical-classification-of-diseases-and-related-health-problems-icd-10.txt b/baselineTexts/international-statistical-classification-of-diseases-and-related-health-problems-icd-10.txt index fb6896c..e1abb36 100644 --- a/baselineTexts/international-statistical-classification-of-diseases-and-related-health-problems-icd-10.txt +++ b/baselineTexts/international-statistical-classification-of-diseases-and-related-health-problems-icd-10.txt @@ -18,14 +18,14 @@ Release number Amd 10/2014 Release title ICD-10 5th Edition Stage Implementation Key documents -Requirements Specification (Amd 10/2014) -Change Specification (Amd 10/2014) -Implementation Guidance (Amd 10/2014) +Requirements Specification (Amd 10/2014) [Archive Content] +Change Specification (Amd 10/2014) [Archive Content] +Implementation Guidance (Amd 10/2014) [Archive Content] Codes and Titles and Metadata File Specification (Amd 10/2014) -Information Standards Notice (Amd 10/2014) +Information Standards Notice (Amd 10/2014) [Archive Content] Supporting documents -NHS Data Model and Dictionary Change Request 1412 (Amd 10/2014) -Advance Notification (Amd 10/2014) +NHS Data Model and Dictionary Change Request 1412 (Amd 10/2014) [Archive Content] +Advance Notification (Amd 10/2014) [Archive Content] Last edited: 2 November 2018 12:24 pm \ No newline at end of file diff --git a/baselineTexts/interoperability-toolkit-3-messaging-distribution-fhir-api-standards.txt b/baselineTexts/interoperability-toolkit-3-messaging-distribution-fhir-api-standards.txt index c542a2d..37f2041 100644 --- a/baselineTexts/interoperability-toolkit-3-messaging-distribution-fhir-api-standards.txt +++ b/baselineTexts/interoperability-toolkit-3-messaging-distribution-fhir-api-standards.txt @@ -5,8 +5,16 @@ API standards for a set of generic messaging components using FHIR STU3 to creat Page contents Top of page Overview +API status API standards Overview +NHS healthcare system A +MESH +NHS healthcare system B +send FHIR messages and documents +receive FHIR messages and documents + +  These API standards cover a set of generic FHIR messaging components we developed using FHIR STU3 running over MESH to create a unified approach to NHS message and document flows across England.  @@ -18,6 +26,10 @@ The FHIR Messaging components were developed by NHS Digital and use CareConnect For further information, contact the ITK conformance team. +API status + +This API standard is stable. + API standards Year  Name Version Status & Notes Links @@ -70,4 +82,4 @@ public beta and earlier   -Last edited: 16 March 2022 6:01 pm \ No newline at end of file +Last edited: 14 October 2022 6:20 am \ No newline at end of file diff --git a/baselineTexts/maternity-services-data-set.txt b/baselineTexts/maternity-services-data-set.txt new file mode 100644 index 0000000..1a70dc3 --- /dev/null +++ b/baselineTexts/maternity-services-data-set.txt @@ -0,0 +1,35 @@ +DCB1513: Maternity Services Data Set + +The Maternity Services Data Set (MSDS) is the national information standard for data relating to NHS-funded maternity services + +Page contents +Top of page +About this information standard +Current release +About this information standard + +The Maternity Services Data Set (MSDS) sets out requirements for the collection and submission of operational and clinical data relating to each stage of the maternity care pathway. The data will be used, locally and nationally, to support commissioning, payment, planning, outcomes monitoring and addressing health inequalities. Version 2.0 of the standard is a significant change and brings the MSDS into line with the structures of other national data sets managed by NHS Digital. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standard. + +Current release +Release date 14/09/2018 +Release number Amd 10/2018 +Release title Version 2.0 +Stage Implementation +Key documents +Information Standards Notice (Amd 10/2018) +Change Specification (Amd 10/2018) +Requirements Specification (Amd 10/2018) +Implementation Guidance (Amd 10/2018) +Data Set Specification (Amd 10/2018) [Archive Content] + +Supporting documents +NHS Data Model and Dictionary Change Request 1550 (Basic CR) (Amd 10/2018) +NHS Data Model and Dictionary Change Request 1550 (Data Set CR) (Amd 10/2018) +XML Schema (Amd 10/2018) + +Further information     NHS Digital MSDS pages +Previous release Go to the ISB website for information about the previous release + +Last edited: 5 November 2018 12:39 pm \ No newline at end of file diff --git a/baselineTexts/medicine-and-allergyintolerance-data-transfer.txt b/baselineTexts/medicine-and-allergyintolerance-data-transfer.txt index 93cd51c..e94d517 100644 --- a/baselineTexts/medicine-and-allergyintolerance-data-transfer.txt +++ b/baselineTexts/medicine-and-allergyintolerance-data-transfer.txt @@ -28,7 +28,7 @@ Release title Initial Standard Stage Implementation (1 October 2021 to 31 March 2023) Key documents Information Standards Notice (Amd 5/2021) -Requirements Specification v 1.1 (Amd 5/2021) +Requirements Specification v 1.2 (Amd 5/2021) Corrigendum (Amd 5/2021) Supporting documents @@ -42,10 +42,12 @@ FHIR UK Core:  Published versions of the UK Core Implementation Guide Updates +Sept 2022: The developers have redrafted the Requirement Specification (uplifted to version 1.2) to provide more information about the requirements and to reflect the decision by NHS Digital and NHS England to re-architect the current Electronic Prescription Service (EPS).  + 23 May 2022: A 'Supplemental guidance' document has been published by the developers of DAPB4013 at NHS Digital, to summarise and answer common user queries from users implementing the standard. This document has been added to 'Supporting documents' in the table above.   21 March 2022: A minor editorial change has been made to the Corrigendum and Requirements Specification. This update relates to a correction to the hyperlink for the 'Self-assurance guidance' in each document. No other changes to the documents have been made.  9 November 2021: Publication of Corrigendum in respect of the Initial Standard, supported by changes to the Requirements Specification (uplifted to document version 1.1). See Corrigendum above for full details. -Last edited: 23 May 2022 1:55 pm \ No newline at end of file +Last edited: 9 September 2022 2:02 pm \ No newline at end of file diff --git a/baselineTexts/mental-health-inpatient-discharge.txt b/baselineTexts/mental-health-inpatient-discharge.txt index ba443e7..eb1049b 100644 --- a/baselineTexts/mental-health-inpatient-discharge.txt +++ b/baselineTexts/mental-health-inpatient-discharge.txt @@ -27,8 +27,8 @@ The Mental health inpatient discharge has been updated to version 2.1 (Dec 17 20 – structured dose timing and dose direction duration. Previous revisions -– Release Notes V2.0 -– Release Notes V1.1 +Release Notes V2.0 +Release Notes V1.1 Supporting documentation Implementation guidance report – Mental health inpatient discharge diff --git a/baselineTexts/mental-health-services-data-set.txt b/baselineTexts/mental-health-services-data-set.txt new file mode 100644 index 0000000..6e4815f --- /dev/null +++ b/baselineTexts/mental-health-services-data-set.txt @@ -0,0 +1,62 @@ +DCB0011: Mental Health Services Data Set + +The Mental Health Services Data Set (MHSDS) is a national data set, covering mental health and learning disabilities. + +Page contents +Top of page +About this information standard +Current release +Previous releases +Updates +About this information standard + +The Mental Health Services Data Set (MHSDS) is a patient level, output based, secondary uses data set which aims to deliver robust, comprehensive, nationally consistent and comparable person-based information for children, young people and adults who are in contact with services for mental health and wellbeing, learning disability, autism or other neurodevelopmental conditions.  As a secondary uses data set it re-uses clinical and operational data for purposes other than direct patient care. It defines the data items, definitions and associated value sets to be extracted or derived from local information systems. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Version 5.0 +Release date 08/04/2021 (updated 6 August 2021, 7 January 2022) +Release number Amd 29/2020 +Stage Implementation +Key documents +Change Specification v1.1 (Amd 29/2020) (August 2021) +Requirements Specification (Amd 29/2020) +Implementation Guidance (Amd 29/2020) +Information Standards Notice (Amd 29/2020) +Corrigendum (Amd 29/2020) (August 2021) +Second Corrigendum (Amd 29/2020) (January 2022)  + +Supporting documents +Data Set Specification v1.2 (Amd 29/2020) (January 2022) [Archive Content] +NHS Data Model and Dictionary Change Request 1856 v1.0 (Amd 29/2020) (Basic CR) (January 2022) +NHS Data Model and Dictionary Change Request 1768 v2.0 (Amd 29/2020) (Basic CR) (August 2021) +NHS Data Model and Dictionary Change Request 1768 v2.0 (Amd 29/2020) (Data Set CR) (August 2021) + +Further information NHS Digital MHSDS web pages +Previous releases +Version 4.1 +Release date 09/10/2019 +Release number Amd 43/2019 +Stage Maintenance +Key documents +Change Specification (Amd 43/2019) +Requirements Specification (Amd 43/2019) +Implementation Guidance (Amd 43/2019) +Information Standards Notice (Amd 43/2019) + +Supporting documents +Data Set Specification (Amd 43/2019) [Archive Content] +NHS Data Model and Dictionary Change Request - 1732 (Basic CR) (Amd 43/2019) +NHS Data Model and Dictionary Change Request - 1732 (Data Set CR) (Amd 43/2019) +NHS Digital Data Provision Notice + +Documentation from previous releases are available on request from standards.assurance@nhs.net  + +Updates + +Update 7 January 2022: Publication of second Corrigendum in respect of Version 5.0, supported by changes to the Data Set Specification (uplifted to document version 1.2). See Second Corrigendum above for full details. + +Update 6 August 2021: Publication of Corrigendum in respect of Version 5.0, supported by changes to Change Specification and Data Set Specification (both uplifted to document version 1.1). See Corrigendum above for full details. + +Last edited: 22 February 2022 2:59 pm \ No newline at end of file diff --git a/baselineTexts/message-exchange-for-social-care-and-health-mesh-api.txt b/baselineTexts/message-exchange-for-social-care-and-health-mesh-api.txt index de42ea3..0a20e25 100644 --- a/baselineTexts/message-exchange-for-social-care-and-health-mesh-api.txt +++ b/baselineTexts/message-exchange-for-social-care-and-health-mesh-api.txt @@ -2,6 +2,9 @@ Message Exchange for Social Care and Health (MESH) API Transfer messages and large files securely across health and social care organisations using the Message Exchange for Social Care and Health (MESH) API. +This specification is written from an OAS file. + +Get OAS file Page content Top of page Overview @@ -10,25 +13,28 @@ Prerequisites Related APIs API status and roadmap Service level -Service level Technology Network access Environments and testing MESH Authorization header MESH API pseudocode Onboarding -Endpoints +Endpoints: Handshake +Validate a mailbox (Handshake) +Endpoints: Inbox Acknowledge message Check an inbox Check an inbox count (deprecated) Download message Download message chunk +Endpoints: Lookup Look up MESH address -Track outbox -Track outbox (deprecated) +Endpoints: Outbox Send chunked message Send message -Validate a mailbox (Handshake) +Endpoints: Tracking +Track outbox +Track outbox (deprecated) Overview Use this API to securely transfer healthcare data between organisations using the Message Exchange for Social Care and Health (MESH), which is a component of Spine. @@ -86,12 +92,6 @@ This API is a silver service, meaning it is operational 24 x 7 x 365 but only su For more details, see service levels. -Service level - -This API is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. - -For more details, see service levels. - Technology This API is RESTful. @@ -151,7 +151,7 @@ The authorisation token is made up of six elements. With the exception of the fi Name Description NHSMESH The name of the Custom Authentication Schema. The space at the end of the schema is important. -mailbox_id ID of the mailbox sending the HTTP Request. Must be uppercase. +mailbox_id The mailbox identifier sending the HTTP Request. Must be uppercase. nonce A GUID used as an encryption nonce. nonce_count The number of times that the same nonce has been used. timestamp The current date and time in yyyyMMddHHmm format. @@ -159,13 +159,13 @@ hash HMAC-SHA256 hash - see the list below. The hash is compiled of the following items: -The key is the MESH environment shared secret +The key is the MESH environment shared secret, provided by itoc.supportdesk@nhs.net as part of onboarding to the PTL environment. The message is the concatenation of the 5 following elements, joined by a colon (:): -mailbox_id - same as element 2 -nonce - same as element 3 -nonce_count - same as element 4 -mailbox_password - The password for the MESH mailbox -timestamp - same as element 5 +mailbox_id +nonce +nonce_count +mailbox_password +timestamp Changing the nonce and/or nonce_count elements between requests ensures the Authorization header is unique and valid. @@ -223,12 +223,12 @@ Validate your mailbox once every 24 hours using the 'Validate a mailbox' endpoin Inbox poll cycle -Spine gives each message a unique messageID after you post it to your outbox. It is the primary identifier for the message during MESH transit. +Spine gives each message a unique message identifier after you post it to your outbox. It is the primary identifier for the message during MESH transit. Poll your mailbox at most every 5 minutes, but at least every 24 hours. The pseudocode for a mailbox poll is: Poll to get the messageIds of messages ready to download from the 'Check an inbox' endpoint. -For each messageID returned in step 1: +For each message identifier returned in step 1: download the message with the 'Download message' endpoint if it's identified as a chunked message, download all remaining chunks with the 'Download message chunk' endpoint acknowledge receipt of the message via the 'Acknowledge message' endpoint @@ -238,26 +238,29 @@ Asynchronous error reporting Most problems with message transfer are indicated synchronously (immediately) when you call the 'Send Message' endpoint. However, some errors might occur after a successful request (asynchronously). You get any error reports as messages in your inbox, which you need to receive as part of your inbox poll cycle. Error reports differ from regular messages in these ways: -the 'Download message endpoint' has a different value for the Mex-Messagetype header: +the 'Download message endpoint' has a different value for the Mex-MessageType header: DATA for a normal organisation-to-organisation message REPORT for an error report the Download message response body of an error report message is empty -We strongly recommend you check the value of Mex-Messagetype after downloading each message so you can take appropriate action if needed. +We strongly recommend you check the value of Mex-MessageType after downloading each message, so that you can take appropriate action if needed. Error Report Header Description -Mex-Statusevent Step in the MESH server side process when the error occurred -Mex-Linkedmsgid The messageId of the undelivered message -Mex-Workflowid The workflowId of the undelivered message -Mex-Statustimestamp Time the error occurred -Mex-Localid Sender assigned localId of the unacknowledged message -Mex-Statuscode Indicate the status of the message, non-00 indicates error -Mex-Messageid The messageId of the error report (not the undelivered message) -Mex-Statussuccess SUCCESS or ERROR (is always ERROR in an error report) -Mex-Statusdescription Indicate the status the message, non-00 indicates error +Mex-StatusEvent Step in the MESH server side process when the error occurred +Mex-LinkedMsgID The message identifier of the undelivered message +Mex-WorkflowID The workflow identifier of the undelivered message +Mex-StatusTimestamp Time the error occurred +Mex-LocalID Sender assigned local identifier of the unacknowledged message +Mex-StatusCode Indicate the status of the message, non-00 indicates error +Mex-MessageID The message identifier of the error report (not the undelivered message) +Mex-StatusSuccess SUCCESS or ERROR (is always ERROR in an error report) +Mex-StatusDescription Indicate the status the message, non-00 indicates error Mex-To Intended receiver of the undelivered message -Mex-Messagetype REPORT +Mex-MessageType REPORT Mex-Subject The subject of the undelivered message + +Note: Headers should be treated case insensitively, most http clients will do this for you automatically, but please do not rely on explicit case. + Error codes Some of the below errors are only applicable for some API calls. For example, error code 15 would only be found when calling 'Child Protection Information Services' (CP-IS). @@ -272,22 +275,21 @@ Error code Typical description 14 Undelivered message 15 Bad 'Child Protection - Information Sharing' (CP-IS) File 16 Sender is not allowed to send messages of this type -17 Receiver not registered for workflowId -19 workflowId does not support chunked files +17 Workflow ID not registered for mailbox Outbox workflow -The maximum amount of data allowed by MESH in a single request message is 100MB over HSCN conections or 20MB over the internet. You can send larger messages by breaking them into "chunks" that are transmitted as a single message over multiple requests. The upper limit of a single chunked message is 20GB. +The maximum amount of data allowed by MESH in a single request message is 100MB over HSCN connections or 20MB over the internet. You can send larger messages by breaking them into "chunks" that are transmitted as a single message over multiple requests. The upper limit of a single chunked message is 20GB. -The MESH UI and older versions of the MESH client do not support chunking. Check that the receiver's interface to MESH for your workflowId handles chunked messages prior to sending. To do this: +The MESH UI and older versions of the MESH client do not support chunking. Check that the receiver's interface to MESH for your workflow identifier handles chunked messages prior to sending. To do this: -Determine the size of your message data (after compression) with a standard algorithm (such as gzip). If the compressed message is larger than 100MB or 20MB if sending over the internet, is smaller than 20GB, and the receiving mailbox / workflowId supports chunking, then you can send a chunked message. To prepare for this: +Determine the size of your message data (after compression) with a standard algorithm (such as gzip). If the compressed message is larger than 100MB or 20MB if sending over the internet, is smaller than 20GB, and the receiving mailbox / workflow identifier supports chunking, then you can send a chunked message. To prepare for this: split the uncompressed data into ordered chunks independently compress each chunk with the same compression algorithm (such as gzip) such that each chunk is smaller than 100MB use the first chunk (after compression) as the initial message data -Send a message with appropriate workflowId, receiver and mailboxId. To do this: -optionally include localId from step 2 for tracking. This field must not contain PID. +Send a message with appropriate workflow identifier and Mex-To (recipient mailbox) header. To do this: +optionally include a local identifier from step 2 for tracking. This field must not contain PID. if sending a chunked message, include an extra header to indicate that this is the first in a series of chunks, then submit the subsequent chunks via the 'Send Chunked Message' endpoint -A messageID will be returned which is the unique identifer and can be used for tracking and helping with incident resolution. It would be good practice to log this identifier. +A message identifier will be returned which is the unique identifier and can be used for tracking and helping with incident resolution. It would be good practice to log this identifier. Message expiration Messages that are not downloaded and acknowledged within five days of delivery are removed from your inbox. The sending organisation receives an error report explaining that the receiver did not collect the message. Uncollected messages are completely deleted from the MESH server 30 days after the initial delivery. If the sending organisation cannot re-send the message within the intervening time, it may contact the NHS Digital national service desk with the error report details and ask for the message to be placed in your inbox again. @@ -296,85 +298,115 @@ Onboarding You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it's worth planning well ahead: -request a Test mailbox using the form +apply for a Testing (Path to Live) mailbox using the form read carefully how to request your certificate -send your business use case to sa.servicedesk@nhs.net -when you receive your SCAL (Supplier Conformance Assessment List), fill in and return it to sa.servicedesk@nhs.net -our solutions assurance team certificates your integration and it's ready to go live - -For any other queries, contact our support mailbox ssd.nationalservicedesk@nhs.net. -Endpoints -Acknowledge message -PUT /messageexchange/{mailboxID}/inbox/{messageID}/status/acknowledged -Overview +This API uses our online digital onboarding process. -Use this endpoint to acknowledge the successful download of a message. +For more details, and to get started, see digital onboarding. -This operation: +For any other queries, contact our support mailbox ssd.nationalservicedesk@nhs.net. -closes the message transaction on Spine -removes the message from your mailbox inbox, which means that the messageId does not appear in subsequent calls to the 'Check inbox' endpoint and cannot be downloaded again +Endpoints: Handshake +Validate a mailbox (Handshake) +GET /messageexchange/{mailbox_id} +Overview -If you fail to acknowledge a message after five days in the inbox this sends a non-delivery report to the sender's inbox. +Use this endpoint to check that MESH can be reached and that the authentication you are using is correct. This endpoint only needs to be called once every 24 hours. This endpoint updates the details of the connection history held for your mailbox and is similar to a keep-alive or ping message, in that it allows monitoring on the Spine to be aware of the active use of a mailbox despite a lack of traffic. Request SHELL Copy - curl -k \ - --request 'PUT' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:bb59be38-e50b-4e5a-9f11-e566e7509552:0:202006041718:8c415905280304918033bcab054909e4582e5fdf544eb18a9dd7366fb868bcf3' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/\ - 20200529155357895317_3573F8/status/acknowledged +curl -k \ + --request 'GET' \ + --cacert 'mesh-ca.pem' \ + --key 'mesh-client-key.pem' \ + --cert 'mesh-client-cert.pem' \ + --header 'Authorization: NHSMESH X26HC005:1c820cd4-be3e-43ff-807f-e65362892722:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ + --header 'Mex-ClientVersion: ApiDocs==0.0.1' \ + --header 'Mex-OSArchitecture: x86_64' \ + --header 'Mex-OSName: Linux' \ + --header 'Mex-OSVersion: #44~18.04.2-Ubuntu' \ + https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005 -Response +Request +Path parameters +Name Description +mailbox_id -JSON +String -Copy - { "messageId" : "20200529155357895317_3573F8" } +The ID of the mailbox -Request -Path parameters +Example: MAILBOX01 + +Required +Headers Name Description -messageID +Authorization String -The ID of the message +Authentication headers + +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced Required -mailboxID +Mex-ClientVersion String -The ID of the mailbox +Client version number -Example: MAILBOX01 +Example: ApiDocs==0.0.1 Required -Headers -Name Description -Authorization + +Mex-OSName String -Authentication headers +Operating system name + +Example: Linux + +Required + +Mex-OSVersion + +String + +Operating system version -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: #44~18.04.2-Ubuntu Required + +Mex-OSArchitecture + +String + +{Operating System Architecture} + + +Mex-JavaVersion + +String + +{JVM Version Number} + Response HTTP status: 200 OK +HTTP status: 400 + +Bad Request + Body Content type: application/json @@ -385,11 +417,6 @@ Name Description object - -messageID -string - -Example: 20200529155357895317_3573F8 HTTP status: 403 Authentication failed @@ -404,73 +431,127 @@ Name Description object +Endpoints: Inbox +Acknowledge message +PUT /messageexchange/{mailbox_id}/inbox/{message_id}/status/acknowledged +Overview -messageID -string - +Use this endpoint to acknowledge the successful download of a message. -ID of the allocated message +This operation: -Example: 20200529155357895317_3573F8 +closes the message transaction on Spine +removes the message from your mailbox inbox, which means that the message identifier does not appear in subsequent calls to the 'Check inbox' endpoint and cannot be downloaded again +Note: If you fail to acknowledge a message after five days in the inbox this sends a non-delivery report to the sender's inbox. -errorEvent -string - +Request -Status event +SHELL -Example: status event +Copy +curl -k \ +--request 'PUT' \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC005:bb59be38-e50b-4e5a-9f11-e566e7509552:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/20200529155357895317_3573F8/status/acknowledged +Response -errorCode -integer - +JSON -Status code +Copy +{ "messageId" : "20200529155357895317_3573F8" } -Example: 403 +Request +Path parameters +Name Description +message_id +String -errorDescription +The ID of the message + +Required + +mailbox_id + +String + +The ID of the mailbox + +Example: MAILBOX01 + +Required +Headers +Name Description +Authorization + +String + +Authentication headers + +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced + +Required +Response +HTTP status: 200 + +OK + +Body + +Content type: application/json + +Schema +Collapse all Expand all +Name Description + +object + + +messageID string +Example: 20200529155357895317_3573F8 +HTTP status: 403 -Description of the status +Authentication failed -Example: Description of the status Check an inbox -GET /messageexchange/{mailboxID}/inbox +GET /messageexchange/{mailbox_id}/inbox Overview -Use this endpoint to return the messageId of messages in the mailbox inbox ready for download. Client systems MUST poll their assigned inbox a minimum of once a day and a maximum of once every five minutes for messages (unless there are more messages waiting to download). +Use this endpoint to return the message identifier of messages in the mailbox inbox ready for download. Client systems MUST poll their assigned inbox a minimum of once a day and a maximum of once every five minutes for messages (unless there are more messages waiting to download). -A maximum of 500 messageId are returned in every request. Continue the polling and download cycle until you empty the mailbox and you receive less than 500 messages in the response. +A maximum of 500 message identifier are returned in every request. Continue the polling and download cycle until you empty the mailbox and you receive less than 500 messages in the response. Request SHELL Copy - curl -k \ - --request 'GET' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:66eef28b-e097-421d-998d-ea0c92c2c2fb:0:202006041718:60e25fb4c6b400d7e3dfa901b68715b2fda4cfbcd27b8bff3d21dbaae06a65d5' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox +curl -k \ +--request 'GET' \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC005:66eef28b-e097-421d-998d-ea0c92c2c2fb:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox Response JSON Copy - {"messages": []} +{"messages": []} Request Path parameters Name Description -mailboxID +mailbox_id String @@ -487,7 +568,7 @@ String Authentication headers -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced Required Response @@ -567,7 +648,7 @@ Description of the status Example: Description of the status Check an inbox count (deprecated) -GET /messageexchange/{mailboxID}/count +GET /messageexchange/{mailbox_id}/count Overview Use this endpoint to check the number of messages currently held in the MESH mailbox that are ready to download. @@ -577,7 +658,7 @@ This endpoint is now deprecated as it is not needed as part of the polling cycle Request Path parameters Name Description -mailboxID +mailbox_id String @@ -594,7 +675,7 @@ String Authentication headers -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced Required Response @@ -654,47 +735,13 @@ HTTP status: 403 Authentication failed -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - - -errorEvent -string - - -Status event - -Example: status event - - -errorCode -integer - - -Status code - -Example: 403 - - -errorDescription -string - - -Description of the status - -Example: Description of the status Download message -GET /messageexchange/{Recipient}/inbox/{messageID} +GET /messageexchange/{mailbox_id}/inbox/{message_id} Overview -Use this endpoint to retrieve a message based on the messageid obtained from the 'Check Inbox' endpoint. +Use this endpoint to retrieve a message based on the message identifier obtained from the 'Check Inbox' endpoint. + +Note: Headers should be treated case insensitively, most http clients will do this for you automatically, but please do not rely on explicit case. Message expiration @@ -702,10 +749,10 @@ Messages you do not download and acknowledge within five days of delivery are re Report Messages -The Mex-Messagetype header indicates if the payload is a DATA message or a REPORT. +The Mex-MessageType header indicates if the payload is a DATA message or a REPORT. Error reports differ from regular messages in these ways: -the Download message endpoint has a different value for the Mex-Messagetype header +the Download message endpoint has a different value for the Mex-MessageType header DATA for a normal organisation-to-organisation message REPORT for an error report the Download message response body of an error report message is empty @@ -714,25 +761,25 @@ Request SHELL Copy - curl -k \ - --request 'GET' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:2942264f-46e5-450f-90fc-22a0c09efa37:0:202006041718:bba1c9550e6ce5f2fff2c98712b27c4bf7f8b8bf9dfda3f52e27e6db71dd8f9d' \ - https://msg.int.spine2.ncrs.nhs.uk/messageexchange/recipient/inbox/messageID +curl -k \ +--request 'GET' \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC005:2942264f-46e5-450f-90fc-22a0c09efa37:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://msg.int.spine2.ncrs.nhs.uk/messageexchange/X26HC005/inbox/20200529155357895317_3573F8 Response JSON Copy - {"messages": ["20200529155357895317_3573F8"]} +{"messages": ["20200529155357895317_3573F8"]} Request Path parameters Name Description -messageID +message_id String @@ -740,13 +787,13 @@ The ID of the message Required -Recipient +mailbox_id String -Recipient mailbox ID +Mailbox ID -Example: {Recipient Mailbox ID} +Example: {Mailbox ID} Required Headers @@ -757,7 +804,7 @@ String Authentication headers -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced Required Response @@ -793,6 +840,10 @@ HTTP status: 403 Authentication failed +HTTP status: 410 + +Gone, message has already been downloaded and acknowledged + Body Content type: application/json @@ -803,80 +854,33 @@ Name Description object +Download message chunk +GET /messageexchange/{mailbox_id}/inbox/{message_id}/{chunkNo} +Overview -messageID -string - +Use this endpoint to download a chunked message. Initially, call the 'Download Message' endpoint with the message identifier given by the 'Check Inbox' endpoint as usual. When the message is chunked, the 'Download message' endpoint response differs in two ways: -ID of the allocated message +the response code is '206: Partial Content' (instead of '200: OK') +the response headers contain Mex-Chunk-Range: 1:n -Example: 20200529155357895317_3573F8 +This endpoint is used to download the remaining n-1 chunks. +Note: Headers should be treated case insensitively, most http clients will do this for you automatically, but please do not rely on explicit case. -errorEvent -string - +Request -Status event - -Example: status event - - -errorCode -integer - - -Status code - -Example: 403 - - -errorDescription -string - - -Description of the status - -Example: Description of the status -HTTP status: 410 - -Gone, message has already been downloaded and acknowledged - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - -Download message chunk -GET /messageexchange/{Recipient}/inbox/{messageID}/{chunkNo} -Overview - -Use this endpoint to download a chunked message. Initially, call the 'Download Message' endpoint with the messageId given by the 'Check Inbox' endpoint as usual. When the message is chunked, the 'Download message' endpoint response differs in two ways: - -the response code is '206: Partial Content' (instead of '200: OK') -the response headers contain Mex-Chunk-Range: 1:n - -This endpoint is used to download the remaining n-1 chunks. - -Request - -Following on from the example in the 'Send chunked message' endpoint, Alice checks her inbox and sees a new message. +Following on from the example in the 'Send chunked message' endpoint, Alice checks her inbox and sees a new message. SHELL Copy - curl -k \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --request 'GET' \ - --header 'Authorization: NHSMESH X26HC005:142b8a1e-e953-4e5e-98a8-b27741e15747:0:202006041718:0ab046e6c9ed7ed0e47eef3e04725846047d7ee3e71e868c84ffda32e24926f4' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox +curl -k \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--request 'GET' \ +--header 'Authorization: NHSMESH X26HC005:142b8a1e-e953-4e5e-98a8-b27741e15747:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox She downloads the first part of the message. Note this use of curl uses the --include argument, to show the value of the HTTP headers in the MESH response. @@ -884,50 +888,49 @@ She downloads the first part of the message. Note this use of curl uses the --in SHELL Copy - curl -k \ - --include \ - --request 'GET' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:777670ce-02f7-44fe-a53b-eb33eb1cb564:0:202006041718:8d22e541bbfd55baeccb6e088704320c75ea150fc8fa7dc137121cbdf939a7bb' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/\ - 20200601122152994285_D59900 | tr -d '\r' +curl -k \ +--include \ +--request 'GET' \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC005:777670ce-02f7-44fe-a53b-eb33eb1cb564:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/20200601122152994285_D59900 SHELL Copy - HTTP/1.1 206 Partial Content - Server: nginx - Date: Mon, 01 Jun 2020 12:24:09 GMT - Content-Type: application/octet-stream - Content-Length: 100 - Connection: keep-alive - Mex-Chunk-Range: 1:2 - Mex-Workflowid: API-DOCS-TEST - Mex-Content-Compressed: N - Mex-Addresstype: ALL - Mex-Statussuccess: SUCCESS - Mex-Statusdescription: Transferred to recipient mailbox - Mex-Messagetype: DATA - Mex-Statusevent: TRANSFER - Mex-Tosmtp: x26hc005@dts.nhs.uk - Mex-Version: 1.0 - Mex-Fromsmtp: x26hc006@dts.nhs.uk - Mex-To: X26HC005 - Mex-Statustimestamp: 20200601122152 - Mex-Localid: api-docs-bob-sends-alice-a-chunked-file - Mex-Statuscode: 00 - Mex-Filename: message.txt.gz - Mex-Messageid: 20200601122152994285_D59900 - Mex-From: X26HC006 - - Hi Alice, - - This is Bob. It's really nice that we can communicate via SPINE! - - I hope to hear more fro +HTTP/1.1 206 Partial Content +Server: nginx +Date: Mon, 01 Jun 2020 12:24:09 GMT +Content-Type: application/octet-stream +Content-Length: 100 +Connection: keep-alive +Mex-Chunk-Range: 1:2 +Mex-WorkflowID: API-DOCS-TEST +Mex-Content-Compressed: N +Mex-AddressType: ALL +Mex-StatusSuccess: SUCCESS +Mex-StatusDescription: Transferred to recipient mailbox +Mex-MessageType: DATA +Mex-StatusEvent: TRANSFER +Mex-ToSMTP: x26hc005@dts.nhs.uk +Mex-Version: 1.0 +Mex-FromSMTP: x26hc006@dts.nhs.uk +Mex-To: X26HC005 +Mex-StatusTimestamp: 20200601122152 +Mex-LocalID: api-docs-bob-sends-alice-a-chunked-file +Mex-StatusCode: 00 +Mex-FileName: message.txt.gz +Mex-MessageID: 20200601122152994285_D59900 +Mex-From: X26HC006 + +Hi Alice, + +This is Bob. It's really nice that we can communicate via SPINE! + +I hope to hear more fro Here we have added the --include argument to curl which prints more response information, including the HTTP response code and response headers. (tr -d '\r' invokes a linux utility to strip carriage returns from the end of each of the lines added to the curl --include argument). @@ -939,43 +942,42 @@ Alice makes another call to retrieve the second part of the message. SHELL Copy - curl -k \ - --include \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:71139532-9215-4ff8-8a74-d602386bac30:0:202006041718:a23d903df6b10388e9c0b12d651ce3cc0e2016006dc72e2f9671f596c9bb70c4' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/\ - 20200601122152994285_D59900/2 | tr -d '\r' +curl -k \ +--include \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC005:71139532-9215-4ff8-8a74-d602386bac30:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/20200601122152994285_D59900/2 SHELL Copy - HTTP/1.1 200 OK - Server: nginx - Date: Mon, 01 Jun 2020 12:24:17 GMT - Content-Type: application/octet-stream - Content-Length: 27 - Connection: keep-alive - Mex-Content-Compressed: N - Mex-Addresstype: ALL - Mex-Localid: api-docs-bob-sends-alice-a-chunked-file - Mex-Tosmtp: x26hc005@dts.nhs.uk - Mex-Chunk-Range: 2:2 - Etag: "866243ab74e0107a4d5835f8d6552e7f20c39ee1" - Mex-Filename: message.txt.gz - Mex-Version: 1.0 - Mex-Fromsmtp: x26hc006@dts.nhs.uk - Mex-Workflowid: API-DOCS-TEST - Mex-To: X26HC005 - Mex-Messagetype: DATA - Mex-Messageid: 20200601122152994285_D59900 - Mex-From: X26HC006 - - m you in the future, - - Bob. +HTTP/1.1 200 OK +Server: nginx +Date: Mon, 01 Jun 2020 12:24:17 GMT +Content-Type: application/octet-stream +Content-Length: 27 +Connection: keep-alive +Mex-Content-Compressed: N +Mex-AddressType: ALL +Mex-LocalID: api-docs-bob-sends-alice-a-chunked-file +Mex-ToSMTP: x26hc005@dts.nhs.uk +Mex-Chunk-Range: 2:2 +Etag: "866243ab74e0107a4d5835f8d6552e7f20c39ee1" +Mex-FileName: message.txt.gz +Mex-Version: 1.0 +Mex-FromSMTP: x26hc006@dts.nhs.uk +Mex-WorkflowID: API-DOCS-TEST +Mex-To: X26HC005 +Mex-MessageType: DATA +Mex-MessageID: 20200601122152994285_D59900 +Mex-From: X26HC006 + +m you in the future, + +Bob. That this is the final part of the message is indicated in two ways: @@ -985,7 +987,7 @@ the Mex-Chunk-Range response header is 2:2 Request Path parameters Name Description -Recipient +mailbox_id String @@ -995,7 +997,7 @@ Example: {Recipient Mailbox ID} Required -messageID +message_id String @@ -1020,7 +1022,7 @@ String Authentication headers -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced Required Response @@ -1056,51 +1058,6 @@ HTTP status: 403 Authentication failed -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - - -messageID -string - - -ID of the allocated message - -Example: 20200529155357895317_3573F8 - - -errorEvent -string - - -Status event - -Example: status event - - -errorCode -integer - - -Status code - -Example: 403 - - -errorDescription -string - - -Description of the status - -Example: Description of the status HTTP status: 404 Message does not exist @@ -1115,11 +1072,12 @@ Name Description object +Endpoints: Lookup Look up MESH address -GET /endpointlookup/mesh/{odsCode}/{Mex-workflowid} +GET /messageexchange/endpointlookup/{ods_code}/{workflow_id} Overview -Use this endpoint to search for the mailbox of the organisation you want to send data to, using their unique Organisation Data Service (ODS) code, their MESH mailboxID and the agreed workflowId for the data. +Use this endpoint to search for the mailbox of the organisation you want to send data to, using their unique Organisation Data Service (ODS) code, their MESH mailbox and the agreed workflow identifier for the data. An example call: @@ -1132,8 +1090,7 @@ curl -k \ --cacert 'mesh-ca.pem' \ --key 'mesh-client-key.pem' \ --cert 'mesh-client-cert.pem' \ ---header 'Authorization: NHSMESH X26HC005:a5d25a21-57c3-40d1-8794-bea42e82039b:0:202006041718:725665f0956b73c5f9ec5e0e0d413046fc0729e3b893864b6d5f672dda2bfd13' \ -https://mesh-sync.spineservices.nhs.uk/endpointlookup/mesh/SCREEN2/SPINE_GPCAPITATION_EXTRACT +https://mesh-sync.spineservices.nhs.uk/messageexchange/endpointlookup/SCREEN2/SPINE_GPCAPITATION_EXTRACT Response @@ -1162,12 +1119,12 @@ Copy } -Note: neither the ods-code nor workflowId in this example are real. +Note: neither the ODS code or workflow identifier in this example are real. Request Path parameters Name Description -odsCode +ods_code String @@ -1177,7 +1134,7 @@ Example: SCREEN2 Required -Mex-workflowid +workflow_id String @@ -1194,7 +1151,7 @@ String Authentication headers -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced Required Response @@ -1222,149 +1179,113 @@ Example: 20200601131040203367_A441C2_1573484974 results array -HTTP status: 403 +Endpoints: Outbox +Send chunked message +POST /messageexchange/{mailbox_id}/outbox/{message_id}/{chunkNo} +Overview -Message does not exist +Use this endpoint to send a chunked message. The 'Send Message' endpoint has a maximum single request message payload size of 100MB over HSCN or 20MB over the internet. However, you can send much larger messages (up to 20GB) by breaking up the message into chunks and transmitting it over multiple requests. -Body +Note: Some workflow ids do not support chunking because it is not currently supported in the MESH UI and older versions of the MESH client. Check with your receiving organisation before sending messages with this endpoint. -Content type: application/json +To send a chunked message: -Schema -Collapse all Expand all -Name Description +Split it into separate files +Compress the individual chunks separately with the same compression program (e.g. gzip). +DO NOT compress a large file and then split the compressed version +Upload the first file using the normal 'Send message' endpoint. +include the Mex-Chunk-Range header with a value of 1:n where n is the number of separate files your big data is split into +capture the message identifier field in the returned JSON +Upload subsequent files in the correct order using the chunked message endpoint -object - -Track outbox -GET /messageexchange/{mailboxID}/outbox/tracking -Overview +Note: fewer headers are required for the chunked message endpoint because Spine uses the relevant metadata from the initial (Mex-Chunk-Header=1:n) call to the 'Send message' endpoint. -Use this endpoint to enquire about the status of messages sent from your outbox. When determining the frequency of the calling of this endpoint consider that MESH is asynchronous and it might be some hours until the recipient downloads your message. You must not poll this endpoint frequently. +Request -The messageId is the value returned in the response to a message upload. +Suppose Bob has a large file to send to Alice. In this example we will use message.txt. It is easily small enough to send in a single request, but we will chunk it anyway to illustrate the API calls. -Do not use this endpoint to replace a business ack message. If the business process requires confirmation that the recipient has processed the message then send a business ACK over MESH. The convention is to use the same workflowId appended with _ACK). +SHELL -Request +Copy +ls -sh message.txt +4.0kb message.txt -It is possible for Bob to check the status of the chunked message he sent to Alice. (Note that in this example, Alice has not acknowledged the chunked message she received from Bob). SHELL Copy - curl -k \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC006:1f6c9442-eb9a-440c-b4ed-ee4fd525e176:0:202006041718:c2d92e6abd637e664fd8bdbf1d753c7d42a16ee2bc317f62a654ef649a9956d7' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox/tracking?messageID=20210311101813838554_1B8F53 +cat message.txt -Response +Hi Alice, -JSON +This is Bob. It's really nice that we can communicate via SPINE! -Copy - { - "processId": null, - "addressType": "ALL", - "localId": "api-docs-bob-sends-alice-a-chunked-file", - "recipientBillingEntity": "England", - "dtsId": "20210311101813838554_1B8F53", - "statusSuccess": null, - "messageType": "DATA", - "statusTimestamp": null, - "senderBillingEntity": "England", - "senderOdsCode": "X26", - "partnerId": null, - "recipientName": "APIM bebop", - "senderName": "APIM bebop", - "subject": null, - "statusEvent": null, - "version": "1.0", - "encryptedFlag": null, - "statusDescription": null, - "senderOrgName": "TEST Org Partnership Trust", - "status": "Accepted", - "workflowId": "API-DOCS-TEST", - "senderOrgCode": "TestOrg", - "recipientOrgName": "TEST Org Partnership Trust", - "expiryTime": "20200606122153", - "senderSmtp": "x26hc006@dts.nhs.uk", - "fileName": "message.txt.gz", - "recipientSmtp": "x26hc005@dts.nhs.uk", - "meshRecipientOdsCode": "X26", - "compressFlag": null, - "uploadTimestamp": "20200601122152", - "recipient": "X26HC005", - "contentsBase64": true, - "sender": "X26HC006", - "checksum": null, - "isCompressed": null, - "contentEncoding": "gzip", - "recipientOrgCode": "TestOrg", - "messageId": "20210311101813838554_1B8F53", - "statusCode": null, - "fileSize": 187 - } +I hope to hear more from you in the future, +Bob. -Suppose Alice only now acknowledges the message Bob sent. -Request +First we break up our one "large" file into two smaller files. We will transmit one per request. SHELL Copy - curl -k \ - --request 'PUT' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:57db9dd2-2156-4c02-90d4-66e7082179db:0:202006041718:aae81ea5fc3757a6218df2a6dc9991d447dbd406dba15e1ca67540f9411e7388' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/\ - 20210311101813838554_1B8F53/status/acknowledged +split -b 100 message.txt message.txt_ +ls -sh message.txt_* -Response -JSON +Large messages should be compressed to reduce the bandwidth and storage requirements for Spine. -Copy - {"messageId" : "20210311101813838554_1B8F53" } +SHELL +Copy +for chunk_file in message.txt_*; do + gzip -k -f $chunk_file; +done +ls -sh message.txt_*.gz -The next call to Track outbox by Bob +4.0kb message.txt_aa.gz +4.0kb message.txt_ab.gz -Request SHELL Copy - curl -k \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC006:dd3f8609-b2c3-4f5a-aa62-c456579b8f77:0:202006041718:9d5dc80e4ac8d89c1ce0e8feaa1e14b2c3ab9ee3ccc95f3f8483086e2ed40bd8' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox/tracking?messageID=20210311101813838554_1B8F53 +curl -k \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--request 'POST' \ +--header 'Authorization: NHSMESH X26HC006:2c6e938e-9a72-4a7a-9664-96ac1f341331:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +--header 'Content-Type: application/octet-stream' \ +--header 'Mex-From: X26HC006' \ +--header 'Mex-To: X26HC005' \ +--header 'Mex-WorkflowID: API-DOCS-TEST' \ +--header 'Mex-FileName: message.txt.gz' \ +--header 'Mex-LocalID: api-docs-bob-sends-alice-a-chunked-file' \ +--header 'Mex-Chunk-Range: 1:2' \ +--header 'Content-Encoding: gzip' \ +--data-binary '@message.txt_aa.gz' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox -Response -JSON +SHELL Copy - { - "downloadTimestamp": "20200601122957", - "status": "Acknowledged", - "messageId": "20210311101813838554_1B8F53" - } - - -This shows the status field of the response has changed from Accepted to Acknowledged. All of the fields in the previous response are also included. +curl -k \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--request 'POST' \ +--header 'Authorization: NHSMESH X26HC006:06bf0527-ba77-47f0-b22f-d7d08a88ad26:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +--header 'Mex-Chunk-Range: 2:2' \ +--data-binary '@./message.txt_ab.gz' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox/20200601122152994285_D59900/2 Request Path parameters Name Description -mailboxID +mailbox_id String @@ -1373,15 +1294,22 @@ The ID of the mailbox Example: MAILBOX01 Required -Query parameters -Name Description -messageID + +message_id String -Value of messageID returned in the send message response +The ID of the message -Example: 20210311101813838554_1B8F53 +Required + +chunkNo + +Integer + +The index number of the chunk + +Example: 1 Required Headers @@ -1392,13 +1320,33 @@ String Authentication headers -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced + +Required + +Content-Type + +String + +Type of sent content + +Example: application/octet-stream + +Required + +Mex-Chunk-Range + +String (integer:integer) + +describes which chunk of the range is sent. + +Example: 124 Required Response -HTTP status: 200 +HTTP status: 202 -OK +Accepted Body @@ -1411,271 +1359,196 @@ Name Description object -processId +messageID string -addressType -string - -Example: ALL +Unique message ID, identical to initial Send message endpoint +Example: 20200529155357895317_3573F8 -localId -string + +blockId +integer -Example: api-docs-bob-sends-alice-a-chunked-file +chunkNo assigned to the chunk as supplied in the Mex-chunk-range header, maintained for legacy support -recipientBillingEntity -string - -Example: England +HTTP status: 403 +Authentication failed -dtsId -string - -Example: 20210311101813838554_1B8F53 +Send message +POST /messageexchange/{mailbox_id}/outbox +Overview +Use this endpoint to send a message via MESH. Use the POST command to your virtual outbox. Specify the message recipient in the request headers, with the message contained in the request body. -statusSuccess -string - +Messages larger than 100MB -messageType -string - -Example: DATA +100MB (20MB on internet) is the largest data payload the MESH API accepts in a single request. Compress larger messages to reduce bandwidth and data storage on Spine. If compression does not sufficiently reduce the message size enough for transmission in a single request then you can break it up into smaller chunks and transmit them separately provided: +The total compressed size of the message is < 100MB - this is the Spine upper limit for a single message. +The receiver mailbox and workflow identifier support the downloading of chunked messages. MESH UI and older versions of the MESH client do not support this. -statusTimestamp -string - - -senderBillingEntity -string - -Example: England - +To correctly break the outbound message into valid chunks: -senderOdsCode -string - -Example: X26 +Split the uncompressed message into n ordered chunks such that each (compressed) chunk is smaller than 20MB. +Independently compress each chunk with the same compression algorithm (e.g. gzip). +The first (compressed) chunk of the message should be transmitted using this endpoint (the normal send message endpoint). Include the optional Mex-Chunk-Range header with a value 1:n to tell Spine that this is a chunked message and to wait for n-1 other requests before delivering the message. The message identifier of this initial server response must be captured as it is a required path element of the Send chunked message URL. +Always set the workflow identifier as some workflows are restricted which means the mailbox sender and recipient must be configured for the workflow identifier you send. -partnerId -string - +To discover the recipient mailbox either use the endpointlookup endpoint or for certain workflows you can include demographic details in the Mex-To field. -recipientName -string - -Example: APIM bebop +It is good practice to capture the returned message identifier as this provides a unique identifier which you can use for message tracking. +Request -senderName -string - -Example: APIM bebop +SHELL +Copy +curl -k \ +--request 'POST' \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC006:c1f2df9c-fe9e-4d11-ba78-49a8bc705eb4:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +--header 'Content-Type: application/octet-stream' \ +--header 'Mex-From: X26HC006' \ +--header 'Mex-To: X26HC005' \ +--header 'Mex-WorkflowID: API-DOCS-TEST' \ +--header 'Mex-FileName: None' \ +--header 'Mex-LocalID: api-docs-bob-greets-alice' \ +--data 'This is a message' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox -subject -string - +Response -statusEvent -string - +JSON -version -string - -Example: 1.0 +Copy +{"messageID": "20200529155357895317_3573F8"} +Request +Path parameters +Name Description +mailbox_id -encryptedFlag -string - +String -statusDescription -string - +The ID of the mailbox -senderOrgName -string - -Example: TEST Org Partnership Trust +Example: MAILBOX01 +Required +Headers +Name Description +Authorization -status -string - -Example: Accepted +String +Authentication headers -workflowId -string - -Example: API-DOCS-TEST +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced +Required -senderOrgCode -string - -Example: TestOrg +Content-Type +String -recipientOrgName -string - -Example: TEST Org Partnership Trust +Type of sent content +Example: application/octet-stream -expiryTime -string - -Example: 20200606122153 +Required +Content-Encoding -senderSmtp -string - -Example: x26hc006@dts.nhs.uk +String +Algorithm used to compress the file e.g. 'gzip' -fileName -string - -Example: message.txt.gz +Mex-FileName -recipientSmtp -string - -Example: x26hc005@dts.nhs.uk +String +{Original File Name} -meshRecipientOdsCode -string - -Example: X26 +Example: {Message content should have this file name after receipt} +Required -compressFlag -string - +Mex-From -uploadTimestamp -string - -Example: 20200601122152 +String +Sending organisation's mailbox ID -recipient -string - -Example: X26HC005 +Example: {Sending organisation's mailbox ID} +Required -sender -string - -Example: X26HC006 +Mex-To +String -checksum -string - +Recipient mailbox ID -isCompressed -string - +Example: {Recipient Mailbox ID} -contentEncoding -string - -Example: gzip +Required +Mex-WorkflowID -recipientOrgCode -string - -Example: TestOrg +String +Identifies the Business Workflow associated with the message -messageId -string - -Example: 20210311101813838554_1B8F53 +Example: {Workflow ID} +Required -statusCode -string - +Mex-Chunk-Range -fileSize -integer - -Example: 187 -HTTP status: 403 +String -Message does not exist +1:{n} {if first of n chunks, see Send chunked message} -Body -Content type: application/json +Mex-LocalID -Schema -Collapse all Expand all -Name Description +String -object - -Track outbox (deprecated) -GET /messageexchange/{mailboxID}/outbox/tracking/{localID} -Overview +A unique ID generated by you, must not contain Patient Identifiable Data PID -This endpoint is now deprecated tracking?messageID should be used instead. -Request -Path parameters -Name Description -mailboxID +Mex-Subject String -The ID of the mailbox - -Example: MAILBOX01 +Message subject information, avoid including PID -Required -localID +Mex-Content-Checksum String -Value of Mex-LocalID provided by sender +Checksum of the original file contents -Example: api-docs-bob-sends-alice-a-chunked-file -Required -Headers -Name Description -Authorization +Mex-Content-Encrypted String -Authentication headers - -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 +Indicate to the receiver that contents are encrypted -Required Response -HTTP status: 200 +HTTP status: 202 -OK +Accepted Body @@ -1688,45 +1561,277 @@ Name Description object -processId +messageID string -addressType -string - -Example: ALL +Unique Id assigned by the MESH server +Example: 20200529155357895317_3573F8 +HTTP status: 403 -localId -string - -Example: api-docs-bob-sends-alice-a-chunked-file +Authentication failed +HTTP status: 417 -recipientBillingEntity -string - -Example: England +Invalid Recipient or the workflow is restricted +Body -dtsId -string - -Example: 20200601122152994285_D59900 +Content type: application/json +Schema +Collapse all Expand all +Name Description -statusSuccess -string +object -messageType +messageID string -Example: DATA + +ID of the allocated message -statusTimestamp + +errorEvent +string + + +Status event + + + +errorCode +integer + + +Status code + +Example: 417 + + +errorDescription +string + + +Description of the status + +Endpoints: Tracking +Track outbox +GET /messageexchange/{mailbox_id}/outbox/tracking +Overview + +Use this endpoint to enquire about the status of messages sent from your outbox. When determining the frequency of the calling of this endpoint consider that MESH is asynchronous, and it might be some hours until the recipient downloads your message. You must not poll this endpoint frequently. + +The message identifier is the value returned in the response to a message upload. + +Do not use this endpoint to replace a business ack message. If the business process requires confirmation that the recipient has processed the message then send a business ACK over MESH. The convention is to use the same workflow identifier appended with _ACK. + +Request + +It is possible for Bob to check the status of the chunked message he sent to Alice. (Note that in this example, Alice has not acknowledged the chunked message she received from Bob). + +SHELL + +Copy +curl -k \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC006:1f6c9442-eb9a-440c-b4ed-ee4fd525e176:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox/tracking?messageID=20210311101813838554_1B8F53 + +Response + +JSON + +Copy +{ + "processId": null, + "addressType": "ALL", + "localId": "api-docs-bob-sends-alice-a-chunked-file", + "recipientBillingEntity": "England", + "dtsId": "20210311101813838554_1B8F53", + "statusSuccess": null, + "messageType": "DATA", + "statusTimestamp": null, + "senderBillingEntity": "England", + "senderOdsCode": "X26", + "partnerId": null, + "recipientName": "APIM bebop", + "senderName": "APIM bebop", + "subject": null, + "statusEvent": null, + "version": "1.0", + "encryptedFlag": null, + "statusDescription": null, + "senderOrgName": "TEST Org Partnership Trust", + "status": "Accepted", + "workflowId": "API-DOCS-TEST", + "senderOrgCode": "TestOrg", + "recipientOrgName": "TEST Org Partnership Trust", + "expiryTime": "20200606122153", + "senderSmtp": "x26hc006@dts.nhs.uk", + "fileName": "message.txt.gz", + "recipientSmtp": "x26hc005@dts.nhs.uk", + "meshRecipientOdsCode": "X26", + "compressFlag": null, + "uploadTimestamp": "20200601122152", + "recipient": "X26HC005", + "contentsBase64": true, + "sender": "X26HC006", + "checksum": null, + "isCompressed": null, + "contentEncoding": "gzip", + "recipientOrgCode": "TestOrg", + "messageId": "20210311101813838554_1B8F53", + "statusCode": null, + "fileSize": 187 +} + + +Suppose Alice only now acknowledges the message Bob sent. + +Request + +SHELL + +Copy +curl -k \ +--request 'PUT' \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC005:57db9dd2-2156-4c02-90d4-66e7082179db:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005/inbox/20210311101813838554_1B8F53/status/acknowledged + +Response + +JSON + +Copy +{"messageId" : "20210311101813838554_1B8F53" } + + +The next call to Track outbox by Bob + +Request + +SHELL + +Copy +curl -k \ +--cacert 'mesh-ca.pem' \ +--key 'mesh-client-key.pem' \ +--cert 'mesh-client-cert.pem' \ +--header 'Authorization: NHSMESH X26HC006:dd3f8609-b2c3-4f5a-aa62-c456579b8f77:0:202006041718:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced' \ +https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox/tracking?messageID=20210311101813838554_1B8F53 + +Response + +JSON + +Copy +{ + "downloadTimestamp": "20200601122957", + "status": "Acknowledged", + "messageId": "20210311101813838554_1B8F53" +} + + +This shows the status field of the response has changed from Accepted to Acknowledged. All the fields in the previous response are also included. + +Request +Path parameters +Name Description +mailbox_id + +String + +The ID of the mailbox + +Example: MAILBOX01 + +Required +Query parameters +Name Description +messageID + +String + +Value of messageID returned in the send message response + +Example: 20210311101813838554_1B8F53 + +Required +Headers +Name Description +Authorization + +String + +Authentication headers + +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced + +Required +Response +HTTP status: 200 + +OK + +Body + +Content type: application/json + +Schema +Collapse all Expand all +Name Description + +object + + +processId +string + + +addressType +string + +Example: ALL + + +localId +string + +Example: api-docs-bob-sends-alice-a-chunked-file + + +recipientBillingEntity +string + +Example: England + + +dtsId +string + +Example: 20210311101813838554_1B8F53 + + +statusSuccess +string + + +messageType +string + +Example: DATA + + +statusTimestamp string @@ -1885,7 +1990,7 @@ Example: TestOrg messageId string -Example: 20200601122152994285_D59900 +Example: 20210311101813838554_1B8F53 statusCode @@ -1896,20 +2001,6 @@ fileSize integer Example: 187 -HTTP status: 300 - -Multiple options (The localId provided with the message was not unique) - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - HTTP status: 403 Message does not exist @@ -1924,670 +2015,272 @@ Name Description object -Send chunked message -POST /messageexchange/{mailboxID}/outbox/{messageID}/{chunkNo} +Track outbox (deprecated) +GET /messageexchange/{mailbox_id}/outbox/tracking/{local_id} Overview -Use this endpoint to send a chunked message. The 'Send Message' endpoint has a maximum single request message payload size of 100MB over HSCN or 20MB over the internet. However, you can send much larger messages (up to 20GB) by breaking up the message into chunks and transmitting it over multiple requests. +This endpoint is now deprecated tracking?messageID should be used instead. -Note: Some workflowIDs do not support chunking because it is not currently supported in the MESH UI and older versions of the MESH client. Check with your receiving organisation before sending messages with this endpoint. To send a chunked message: +Request +Path parameters +Name Description +mailbox_id -Split it into separate files -Compress the individual chunks separately with the same compression program (e.g. gzip). -DO NOT compress a large file and then split the compressed version -Upload the first file using the normal 'Send message' endpoint. -include the Mex-Chunk-Range header with a value of 1:n where n is the number of separate files your big data is split into -capture the messageId field in the returned JSON -Upload subsequent files in the correct order using the chunked message endpoint +String -Note: fewer headers are required for the chunked message endpoint because Spine uses the relevant metadata from the initial (Mex-Chunk-Header=1:n) call to the 'Send message' endpoint. +The ID of the mailbox -Request +Example: MAILBOX01 -Suppose Bob has a large file to send to Alice. In this example we will use message.txt. It is easily small enough to send in a single request but we will chunk it anyway to illustrate the API calls. +Required -SHELL +local_id -Copy - ls -sh message.txt - 4.0kb message.txt +String +Value of Mex-LocalID provided by sender -SHELL +Example: api-docs-bob-sends-alice-a-chunked-file -Copy - cat message.txt - - Hi Alice, +Required +Headers +Name Description +Authorization - This is Bob. It's really nice that we can communicate via SPINE! +String - I hope to hear more from you in the future, +Authentication headers - Bob. +Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:3cded68a9e0f9b83f2c5de1b79fc4dac45004523e6658d46145156fa6a03eced +Required +Response +HTTP status: 200 -First we break up our one "large" file into two smaller files. We will transmit one per request. +OK -SHELL +Body -Copy - split -b 100 message.txt message.txt_ - ls -sh message.txt_* +Content type: application/json +Schema +Collapse all Expand all +Name Description -Large messages should be compressed to reduce the bandwidth and storage requirements for Spine. +object + -SHELL +processId +string + -Copy - for chunk_file in message.txt_*; do - gzip -k -f $chunk_file; - done - ls -sh message.txt_*.gz - - 4.0kb message.txt_aa.gz - 4.0kb message.txt_ab.gz +addressType +string + +Example: ALL -SHELL +localId +string + +Example: api-docs-bob-sends-alice-a-chunked-file -Copy - curl -k \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --request 'POST' \ - --header 'Authorization: NHSMESH X26HC006:2c6e938e-9a72-4a7a-9664-96ac1f341331:0:202006041718:8a2bb02f280f544423503c465df23359e8302c039e5113cc0d88e3c1b7283482' \ - --header 'Content-Type: application/octet-stream' \ - --header 'Mex-From: X26HC006' \ - --header 'Mex-To: X26HC005' \ - --header 'Mex-WorkflowID: API-DOCS-TEST' \ - --header 'Mex-FileName: message.txt.gz' \ - --header 'Mex-LocalID: api-docs-bob-sends-alice-a-chunked-file' \ - --header 'Mex-Chunk-Range: 1:2' \ - --header 'Content-Encoding: gzip' \ - --data-binary '@message.txt_aa.gz' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox - -SHELL - -Copy - curl -k \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --request 'POST' \ - --header 'Authorization: NHSMESH X26HC006:06bf0527-ba77-47f0-b22f-d7d08a88ad26:0:202006041718:d41a9c41e98159e180234ba7940a3a208c67389dc2cb22516dd4a11f57ccfabc' \ - --header 'Mex-Chunk-Range: 2:2' \ - --data-binary '@./message.txt_ab.gz' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox/\ - 20200601122152994285_D59900/2 - -Request -Path parameters -Name Description -mailboxID - -String - -The ID of the mailbox - -Example: MAILBOX01 - -Required - -messageID - -String - -The ID of the message - -Required - -chunkNo - -Integer - -The index number of the chunk - -Example: 1 - -Required -Headers -Name Description -Authorization - -String - -Authentication headers - -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 - -Required - -Content-Type - -String - -Type of sent content - -Example: application/octet-stream - -Required - -Mex-Chunk-Range - -String (integer:integer) - -describes which chunk of the range is sent. - -Example: 124 - -Required -Response -HTTP status: 202 - -Accepted - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - - -messageID -string - - -Unique message ID, identical to initial Send message endpoint - -Example: 20200529155357895317_3573F8 - - -blockId -integer - - -chunkNo assigned to the chunk as supplied in the Mex-chunk-range header, maintained for legacy support - -HTTP status: 403 - -Authentication failed - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - - -messageID -string - - -ID of the allocated message - -Example: 20200529155357895317_3573F8 - - -errorEvent -string - - -Status event - -Example: status event - - -errorCode -integer - - -Status code - -Example: 403 - - -errorDescription -string - - -Description of the status - -Example: Description of the status -Send message -POST /messageexchange/{mailboxID}/outbox -Overview - -Use this endpoint to send a message via MESH. Use the POST command to your virtual outbox. Specify the message recipient in the request headers, with the message contained in the request body. - -Messages larger than 100MB - -100MB (20MB on internet) is the largest data payload the MESH API accepts in a single request. Compress larger messages to reduce bandwidth and data storage on Spine. If compression does not sufficiently reduce the message size enough for transmission in a single request then you can break it up into smaller chunks and transmit them separately provided: - -The total compressed size of the message is < 100MB - this is the Spine upper limit for a single message. -The receiver mailboxId and workflowId support the downloading of chunked messages. MESH UI and older versions of the MESH client do not support this. - -To correctly break the outbound message into valid chunks: - -Split the uncompressed message into n ordered chunks such that each (compressed) chunk is smaller than 20MB. -Independently compress each chunk with the same compression algorithm (e.g. gzip). -The first (compressed) chunk of the message should be transmitted using this endpoint (the normal send message endpoint). Include the optional Mex-Chunk-Range header with a value 1:n to tell Spine that this is a chunked message and to wait for n-1 other requests before delivering the message. The messageId of this initial server response must be captured as it is a required path element of the Send chunked message URL. - -Always set the workflowId as some workflowIds are restricted which means the mailbox sender and recipient must be configured for the workflowId you send. - -To discover the recipient mailbox either use the endpointlookup endpoint or for certain workflows you can include demographic details in the Mex-To field. - -It is good practice to capture the returned messageId as this provides a unique identifer which you can use for message tracking. - -Request - -SHELL - -Copy - curl -k \ - --request 'POST' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC006:c1f2df9c-fe9e-4d11-ba78-49a8bc705eb4:0:202006041718:b2539ba3a3d086ea01c8f18488e227a5e8b0418b95870c73fd83a368e6642d49' \ - --header 'Content-Type: application/octet-stream' \ - --header 'Mex-From: X26HC006' \ - --header 'Mex-To: X26HC005' \ - --header 'Mex-WorkflowID: API-DOCS-TEST' \ - --header 'Mex-FileName: None' \ - --header 'Mex-LocalID: api-docs-bob-greets-alice' \ - --data 'This is a message' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC006/outbox - -Response - -JSON - -Copy - {"messageID": "20200529155357895317_3573F8"} - -Request -Path parameters -Name Description -mailboxID - -String - -The ID of the mailbox - -Example: MAILBOX01 - -Required -Headers -Name Description -Authorization - -String - -Authentication headers - -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 - -Required - -Content-Type - -String - -Type of sent content - -Example: application/octet-stream - -Required - -Mex-FileName - -String - -{Original File Name} - -Example: {Message content should have this file name after receipt} - -Required - -Mex-From - -String - -Sending organisation's mailbox ID - -Example: {Sending organisation's mailbox ID} - -Required - -Mex-To - -String - -Recipient mailbox ID - -Example: {Recipient Mailbox ID} - -Required - -Mex-WorkflowID - -String - -Identifies the Business Workflow associated with the message - -Example: {Workflow ID} - -Required - -Mex-Chunk-Range - -String - -1:{n} {if first of n chunks, see Send chunked message} - - -Mex-Content-Compress - -String - -Flag to indicate that the contents have been automically compressed by the client using GZip compression - - -Mex-Content-Encrypted - -String - -Indicate to the receiver that contents are encrypted - - -Mex-Localid - -String - -A unique ID generated by you, must not contain Patient Identifiable Data PID - - -Mex-Subject - -String - -Subject line for message to SMTP MESH mailboxes - - -Content-Encoding - -String - -Algorithm used to compress the file e.g. 'gzip' - - -Mex-MessageType - -String - -DATA - -Required - -Mex-ProcesslID - -String - -{Local process identifer} - - -mex-Content-Checksum - -String - -Checksum of the original file contents - -Response -HTTP status: 202 - -Accepted - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - - -messageID -string - - -Unique Id assigned by the MESH server - -Example: 20200529155357895317_3573F8 -HTTP status: 403 - -Authentication failed - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description - -object - - -messageID -string - - -ID of the allocated message - -Example: 20200529155357895317_3573F8 - - -errorEvent -string - - -Status event - -Example: status event - - -errorCode -integer +recipientBillingEntity +string - -Status code - -Example: 403 +Example: England -errorDescription +dtsId string +Example: 20200601122152994285_D59900 -Description of the status - -Example: Description of the status -HTTP status: 417 - -Invalid Recipient or the workflow is restricted - -Body - -Content type: application/json - -Schema -Collapse all Expand all -Name Description -object +statusSuccess +string -messageID +messageType string - -ID of the allocated message - +Example: DATA -errorEvent +statusTimestamp string -Status event - +senderBillingEntity +string + +Example: England -errorCode -integer +senderOdsCode +string +Example: X26 -Status code - -Example: 417 +partnerId +string + -errorDescription +recipientName string +Example: APIM bebop -Description of the status -Validate a mailbox (Handshake) -GET /messageexchange/{mailboxID} -Overview +senderName +string + +Example: APIM bebop -Use this endpoint to check that MESH can be reached and that the authentication you are using is correct. This endpoint only needs to be called once every 24 hours. This endpoint updates the details of the connection history held for your mailbox and is similar to a keep-alive or ping message, in that it allows monitoring on the Spine to be aware of the active use of a mailbox despite a lack of traffic. -Request +subject +string + -SHELL +statusEvent +string + -Copy -curl -k \ - --request 'GET' \ - --cacert 'mesh-ca.pem' \ - --key 'mesh-client-key.pem' \ - --cert 'mesh-client-cert.pem' \ - --header 'Authorization: NHSMESH X26HC005:1c820cd4-be3e-43ff-807f-e65362892722:0:202006041718:3401727c81320539a9b3cf835d1e7748f18bc49ab333a6c1841b67df88f2e5f7' \ - --header 'Mex-ClientVersion: ApiDocs==0.0.1' \ - --header 'Mex-OSArchitecture: x86_64' \ - --header 'Mex-OSName: Linux' \ - --header 'Mex-OSVersion: #44~18.04.2-Ubuntu' \ - https://mesh-sync.spineservices.nhs.uk/messageexchange/X26HC005 +version +string + +Example: 1.0 -Response -JSON +encryptedFlag +string + -Copy - {"mailboxId" : "X26HC005"} +statusDescription +string + -Request -Path parameters -Name Description -mailboxID +senderOrgName +string + +Example: TEST Org Partnership Trust -String -The ID of the mailbox +status +string + +Example: Accepted -Example: MAILBOX01 -Required -Headers -Name Description -Authorization +workflowId +string + +Example: API-DOCS-TEST -String -Authentication headers +senderOrgCode +string + +Example: TestOrg -Example: Authorization: NHSMESH NONFUNC01:jt81ti68rlvta7379p3ng949rv:1:201511201038:291259e6a73cde3278f99cd5bd3c7ec9b3d1d5479077a8f711bddf58073d5555 -Required +recipientOrgName +string + +Example: TEST Org Partnership Trust -Mex-ClientVersion -String +expiryTime +string + +Example: 20200606122153 -Client version number -Example: ApiDocs==0.0.1 +senderSmtp +string + +Example: x26hc006@dts.nhs.uk -Required -Mex-OSName +fileName +string + +Example: message.txt.gz -String -Operating system name +recipientSmtp +string + +Example: x26hc005@dts.nhs.uk -Example: Linux -Required +meshRecipientOdsCode +string + +Example: X26 -Mex-OSVersion -String +compressFlag +string + -Operating system version +uploadTimestamp +string + +Example: 20200601122152 -Example: #44~18.04.2-Ubuntu -Required +recipient +string + +Example: X26HC005 -Mex-OSArchitecture -String +sender +string + +Example: X26HC006 -{Operating System Architecture} +checksum +string + -Mex-JavaVersion +isCompressed +string + -String +contentEncoding +string + +Example: gzip -{JVM Version Number} -Response -HTTP status: 200 +recipientOrgCode +string + +Example: TestOrg -OK -Body +messageId +string + +Example: 20200601122152994285_D59900 -Content type: application/json -Schema -Collapse all Expand all -Name Description +statusCode +string + -object +fileSize +integer -HTTP status: 400 +Example: 187 +HTTP status: 300 -Bad Request +Multiple options (The localId provided with the message was not unique) Body @@ -2601,7 +2294,7 @@ object HTTP status: 403 -Authentication failed +Message does not exist Body @@ -2614,37 +2307,4 @@ Name Description object -messageID -string - - -ID of the allocated message - -Example: 20200529155357895317_3573F8 - - -errorEvent -string - - -Status event - -Example: status event - - -errorCode -integer - - -Status code - -Example: 403 - - -errorDescription -string - - -Description of the status - -Example: Description of the status \ No newline at end of file +Last edited: 14 October 2022 6:21 am \ No newline at end of file diff --git a/baselineTexts/national-drug-and-alcohol-treatment-monitoring-system-ndtms-data-set.txt b/baselineTexts/national-drug-and-alcohol-treatment-monitoring-system-ndtms-data-set.txt new file mode 100644 index 0000000..6f41eb3 --- /dev/null +++ b/baselineTexts/national-drug-and-alcohol-treatment-monitoring-system-ndtms-data-set.txt @@ -0,0 +1,74 @@ +DAPB0107: National Drug and Alcohol Treatment Monitoring System + +The National Drug and Alcohol Treatment Monitoring System (NDTMS) collects person level, patient identifiable data from drug and alcohol treatment providers at a national level. + +Page contents +Top of page +About this information standard +Current release +Previous release +Updates +About this information standard + +The NDTMS is a well-established collection with early iterations dating back to the 1980s and has been an Information Standard since 2007. + +Providers of drug and alcohol treatment submit data on a monthly basis to the National Drug and Alcohol Treatment Monitoring System (NDTMS), for the purpose of: + +monitoring the effectiveness of drug and alcohol treatment services +supporting the improvement of outcomes for service users +planning and developing services that best meet local needs. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Release date 30/09/2021 +Release number Amd 50/2021 +Release title Dataset Q +Stage Implementation +Key documents +Requirements Specification (Amd 50/2021) +Change Request (Amd 50/2021) (June 2022) +Implementation Guidance (Amd 50/2021) +Information Standards Notice (Amd 50/2021) +Corrigendum (Amd 50/2021) (June 2022) + +Supporting documents +Technical Output Specification - Adult community data set (AD) (Amd 50/2021) (June 2022) +Technical Output Specification - Young People community data set (YP) (Amd 50/2021) (June 2022) +Technical Output Specification - Secure setting Young People data set (SA) (Amd 50/2021) (June 2022) +Technical Output Specification - Secure setting Young People data set (SY) (Amd 50/2021) (June 2022) +NDTMS data flow diagram (Amd 50/2021) + +Further information + +National drug treatment monitoring system dataset guidelines on gov.uk + +  + +Previous release +Release date 04/10/2019 +Release number Amd 38/2019 +Release title Dataset P +Stage Maintenance +Key documents +Requirements Specification (Amd 38/2019) +Change Specification (Amd 38/2019) +Implementation Guidance (Amd 38/2019) +Information Standards Notice (Amd 38/2019) + +Supporting documents +Technical Output Specification - Adult community data set (AD) (Amd 38/2019) +Technical Output Specification - Young People community data set (YP) (Amd 38/2019) +Technical Output Specification - Secure estate Adult data set (SA) (Amd 38/2019) +Technical Output Specification - Secure estate Young People data set (SY) (Amd 38/2019) +NDTMS data flow diagram (Amd 38/2019) + +  + +Documentation from previous releases are available on request from standards.assurance@nhs.net  + +Updates + +28 June 2022: Publication of Corrigendum in respect of Dataset Q (Amd 50/2021), supported by changes to the Change Request and Technical Output Specifications (all uplifted to document version 1.1, June 2022). See Corrigendum above for full details. + +Last edited: 29 June 2022 2:21 pm \ No newline at end of file diff --git a/baselineTexts/national-health-application-and-infrastructure-services-nhais-gp-links-api.txt b/baselineTexts/national-health-application-and-infrastructure-services-nhais-gp-links-api.txt index 5b5e296..36e3731 100644 --- a/baselineTexts/national-health-application-and-infrastructure-services-nhais-gp-links-api.txt +++ b/baselineTexts/national-health-application-and-infrastructure-services-nhais-gp-links-api.txt @@ -1,13 +1,13 @@ -National Health Application and Infrastructure Services - NHAIS GP Links API +National Health Application and Infrastructure Services - NHAIS GP Links Manage GP registrations and other patient data in NHAIS. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -16,8 +16,33 @@ Testing Onboarding Interactions Overview - -Use this API to manage GP registrations and other patient data in National Health Application and Infrastructure Services (NHAIS). +New GP +system +MESH +NHAIS +system +3. send former patient +deregistration notification +Previous GP +system +2. receive new patient +registration request  +Existing GP +system +4. receive former patient deregistration   +notification +2. receive patient +demographics update  +MESH +NHAIS +system +1. send patient +demographics update  +1. send new patient registration request + +  + +Use this integration to manage GP registrations and other patient data in National Health Application and Infrastructure Services (NHAIS). You can: @@ -25,58 +50,59 @@ register a patient at a GP practice receive a patient deregistration (deduction) notification at the previous GP practice update patient demographics information, such as address -This API forms part of the end-to-end GP registration process. For more details on the end-to-end process, contact us. +This integration uses MESH to send and receive messages.  + +This integration forms part of the end-to-end GP registration process. For more details on the end-to-end process, contact us. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development, by contacting us. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development, by contacting us. You must do this before you can go live (see ‘Onboarding’ below).  Related APIs -The following APIs are related to this one: +The following APIs are related to this integration: GP2GP - HL7 V3 API - use this API to transfer patients' electronic health records between old and new practices when they change GPs. Personal Demographics Service - FHIR API - use this new API to search for patients, retrieve patients by NHS number and update patients. Personal Demographics Service - HL7 V3 API - use this if you want to use functions that are not yet available on the FHIR API. -Personal Demographics Service - SMSP API - use this if you want to get PDS data without an authenticated end user (no smartcard required). It is, however, read-only and searches are limited to a single result. Messaging Exchange for Social care and Health (MESH) - use this component of the Spine to deliver messages and files to registered recipients. -API status +Status -This API is stable. +This integration is in production. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -Native API +Native integration -This API is an asynchronous messaging API. In particular: +This integration uses asynchronous messaging. In particular: you send and receive messages via our MESH messaging hub the message payload format is EDIFACT -For more details on using the native API, see our NHAIS developer document library. +For more details on using the native integration, see our NHAIS developer document library. RESTful adaptor -Alternatively, you can access this API via our NHAIS GP Links adaptor - a component you deploy yourself that provides an easy-to-use FHIR-compliant RESTful API. +Alternatively, you can access this integration via our NHAIS GP Links adaptor - a component you deploy yourself that provides an easy-to-use FHIR-compliant RESTful API. Network access -This API uses MESH which is available on both the Health and Social Care Network (HSCN) and the internet. +This integration uses MESH which is available on both the Health and Social Care Network (HSCN) and the internet. For more details, see Network access for APIs. Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -The API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +The integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. @@ -92,6 +118,6 @@ For more details, contact us. Interactions -For more details on using the native API, see our NHAIS developer document library. +For more details on using the native integration, see our NHAIS developer document library. -Last edited: 26 May 2022 4:21 pm \ No newline at end of file +Last edited: 14 October 2022 6:30 am \ No newline at end of file diff --git a/baselineTexts/national-joint-registry-data-set.txt b/baselineTexts/national-joint-registry-data-set.txt new file mode 100644 index 0000000..190a531 --- /dev/null +++ b/baselineTexts/national-joint-registry-data-set.txt @@ -0,0 +1,83 @@ +DCB1567 National Joint Registry Data Set + +The national data set for joint replacement surgery and joint replacement implants. + +Page contents +Top of page +About this information standard +Current release +About this information standard + +The National Joint Registry (NJR) has been in operation for 15 years and provides activity and outcome data about the orthopaedic sector. + +Hip, knee, ankle, elbow and shoulder joint replacements have become common operations, using a wide range of implants. The NJR helps to monitor the performance of these implants and the effectiveness of different types of surgery, improving clinical standards and benefiting patients, clinicians and the orthopaedic sector as a whole. + +The NJR is managed by the Healthcare Quality Improvement Partnership (HQIP) under a contract with NHS England as part of the delivery of the National Clinical Audit and Patient Outcomes Programme (NCAPOP). + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standard + +Current release + +Release date + + + +08/06/2018 + + + + +Release number + + + +Amd 66/2017 + + + + +Release title + + + +Version 7 + + + + +Stage + + + +Implementation + + + + +Key documents + + +Change Specification (Amd 66/2017) +Specification (Amd 66/2017) +Implementation Guide (Amd 66/2017) +Information Standards Notice (Amd 66/2017) + + + +Supporting documents + + +NHS Data Model and Dictionary Change Request 1630 (Basic CR) (Amd 66/2017) +NHS Data Model and Dictionary Change Request 1630 (Data Set CR) (Amd 66/2017) + + + +Previous releases + + + +Please see the ISB website for information on the previous releases. + +  + +Last edited: 5 November 2018 12:35 pm \ No newline at end of file diff --git a/baselineTexts/national-record-locator-fhir-api.txt b/baselineTexts/national-record-locator-fhir-api.txt index 9e01a7a..9fa3cce 100644 --- a/baselineTexts/national-record-locator-fhir-api.txt +++ b/baselineTexts/national-record-locator-fhir-api.txt @@ -201,4 +201,4 @@ For a full list of interactions for this API, see the Development Overview. For details on the general structure of the interactions, see FHIR. -Last edited: 29 April 2022 7:35 am \ No newline at end of file +Last edited: 30 May 2022 12:58 pm \ No newline at end of file diff --git a/baselineTexts/national-workforce-data-set.txt b/baselineTexts/national-workforce-data-set.txt index 514b881..380c0a8 100644 --- a/baselineTexts/national-workforce-data-set.txt +++ b/baselineTexts/national-workforce-data-set.txt @@ -1,69 +1,25 @@ -DAPB1067: National Workforce Data Set -The National Workforce Data Set (NWD), which includes the NHS occupation codes, specifies the data standards to be used for NHS workforce information. - -Page contents -Top of page -About this information standard -Current release -Previous release -Updates -About this information standard - -The National Workforce Data Set (NWD) is a reference data standard comprising standardised definitions to facilitate the capture of nationally consistent information relating to the NHS and wider healthcare workforce. NWD data items support a variety of workforce collections and are also embedded within operational HR/workforce IT systems, including the Electronic Staff Record (ESR) and NHS Jobs. - -This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. - -Current release -Release date 03/02/2022 -Release number Amd 104/2021 -Release title Version 3.3 -Stage Implementation -Key documents -Information Standards Notice (Amd 104/2021) -Change Specification (Amd 104/2021) -Requirements Specification (Amd 104/2021) -Implementation Guidance (Amd 104/2021) -Data Set Specification (Amd 104/2021) - -Supporting documents -NHS Data Model and Dictionary Change Request 1853 (Basic CR) (Amd 104/2021) -NHS Data Model and Dictionary Change Request 1853 (Data Set CR) (Amd 104/2021) - -Further information NHS Digital: National Workforce Data Set -Previous release -Release date 07/01/2021 (updated 24 February 2021) -Release number Amd 69/2020 -Release title Version 3.2 -Stage Maintenance -Key documents -Information Standards Notice (Amd 69/2020) -Corrigendum (Amd 69/2020) -Change Specification version 1.2 (Amd 69/2020) -Requirements Specification (Amd 69/2020) -Implementation Guidance version 1.1 (Amd 69/2020) -Data Set Specification Version 1.1 (Amd 69/2020) - -Supporting documents -NHS Data Model and Dictionary Change Request 1827 (Basic CR) (Amd 69/2020) -NHS Data Model and Dictionary Change Request 1827 (Data Set CR) (Amd 69/2020) - -  - -Review the NWD archive page for previous releases approved by the Data Coordination Board since 2017. - -Documentation from earlier releases approved by the Standardisation Committee for Care Information (SCCI) and the Information Standards Board (ISB) is available on request from the Data Standards Assurance Service - email: standards.assurance@nhs.net   - -Updates - -3 February 2022: Publication of Version 3.3 - -30 June 2021: Publication of an updated Change Specification for Amd 69/2020 Version 3.2, amending one code on page 8, section 2.1, as described below. No changes have been made to any other documents.   - -[05039] Nursing and Midwifery Registered | Surgical Care Practitioner has been corrected to [03022] Nursing and Midwifery Registered | Surgical Care Practitioner - -3 June 2021: Publication of the supporting NHS Data Model and Dictionary Change Requests, following incorporation of version 3.2 in the Dictionary at the end of May 2021. - -24 February 2021: Publication of Corrigendum in respect of Version 3.2, supported by changes to Change Specification, Data Set Specification and Implementation Guidance (all uplifted to document version 1.1). See Corrigendum above for full details. - -Last edited: 4 February 2022 11:39 am \ No newline at end of file + + + + + Internet explorer is no longer supported + + + + + + + + + + + We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team. + + + + + + + + \ No newline at end of file diff --git a/baselineTexts/neonatal-critical-care-minimum-data-set.txt b/baselineTexts/neonatal-critical-care-minimum-data-set.txt new file mode 100644 index 0000000..2bcb51f --- /dev/null +++ b/baselineTexts/neonatal-critical-care-minimum-data-set.txt @@ -0,0 +1,33 @@ +SCCI0075: Neonatal Critical Care Minimum Data Set (version 2) + +The primary purpose of the NCCMDS is to allow the operation of the National Tariff Payment System (NTPS) within neonatal critical care. + +Page contents +Top of page +About this information standard +Releases +About this information standard + +The Neonatal Critical Care Minimum Data Set (NCCMDS) provides a record of what happens to a patient when they receive neonatal critical care in a Neonatal Intensive Care Unit (NICU), Maternity Ward or Neonatal Transitional Care Ward.  + +The primary purpose of the NCCMDS is to allow the operation of the National Tariff Payment System (NTPS) within neonatal critical care. It supports the NTPS by specifying and facilitating the capture of data needed to generate a Neonatal Critical Care Healthcare Resource Group (HRG) for each calendar day (or part thereof) of a period of neonatal critical care. + +This information standard is maintained by the National Casemix Office within NHS Digital. It is related to SCCI0076 Paediatric Critical Care Minimum Data Set, in that it shares common fields and values, including an agreed list of Critical Care Activity Codes. + +An Information Standards Notice (see release table below) provides an overview of scope and implementation timescales, and the Specification and Implementation Documents provide further detail for those who have to implement the information standard. + +Releases +Release date 07/09/2016 +Release number Amd 112/2015 +Release title Version 2.0 +Stage Implementation +Key documents +Requirements Specification (Amd 112/2015) +Implementation Guidance (Amd 112/2015) +Change Specification (Amd 112/2015) [Archive Content] +Information Standards Notice (Amd 112/2015) + +Supporting documents +NHS Data Model and Dictionary Change Request 1545 Changes (Amd 112/2015) + +Last edited: 5 November 2018 10:49 am \ No newline at end of file diff --git a/baselineTexts/neonatal-data-set.txt b/baselineTexts/neonatal-data-set.txt new file mode 100644 index 0000000..eb55fa6 --- /dev/null +++ b/baselineTexts/neonatal-data-set.txt @@ -0,0 +1,56 @@ +DAPB1595: Neonatal Data Set + +The Neonatal Data Set is the authoritative source of national information relating to neonatal patient demographics, clinical interventions, diagnoses and outcomes. + +Page contents +Top of page +About this information standard +Current release +Previous release +About this information standard + +The Neonatal Data Set outlines the data items required for the secondary uses data set, the National Neonatal Research Database (NNRD). The NNRD collects data about the care of babies admitted to NHS neonatal units and is maintained by the Neonatal Data Analysis Unit (NDAU), based at the Chelsea and Westminster Hospital Campus of Imperial College London. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Release date 13/06/2022 +Release number Amd 30/2022 +Release title Version 2.0 +Stage Implementation +Key documents  +Requirements Specification (Amd 30/2022) +Change Specification (Amd 30/2022) +Implementation Guidance (Amd 30/2022) +Information Standards Notice (Amd 30/2022) + +Supporting documents  +Data Set Specification - Episodic Daily (Amd 30/2022) +Data Set Specification - Two Year Follow Up (Amd 30/2022) +Data Quality Assessment (Amd 30/2022) +NHS Data Model and Dictionary Change Request 1738 (Basic CR) (Amd 30/2022) +NHS Data Model and Dictionary Change Request 1738 (Full CR) (Amd 30/2022) + +Further information  + +National Neonatal Research Database (NNRD) + +  + +Previous release +Release date 16/01/2014 +Release number Amd 32/2012 +Release title Initial Standard +Stage Maintenance +Key documents  +Information Standards Notice +Specification +Data Set + +Supporting documents  +NHS Data Model and Dictionary Change Request 1346 – Standard +NHS Data Model and Dictionary Change Request 1346 - Full + +  + +Last edited: 14 June 2022 9:10 am \ No newline at end of file diff --git a/baselineTexts/nhs-111-api-standard.txt b/baselineTexts/nhs-111-api-standard.txt index e8d7306..fde198a 100644 --- a/baselineTexts/nhs-111-api-standard.txt +++ b/baselineTexts/nhs-111-api-standard.txt @@ -43,4 +43,4 @@ NHS 111 Domain Message Specification V2.1 RC1 ZIP 18 MB -Last edited: 26 May 2022 4:22 pm \ No newline at end of file +Last edited: 14 October 2022 6:32 am \ No newline at end of file diff --git a/baselineTexts/nhs-app-api.txt b/baselineTexts/nhs-app-api.txt index a633aa6..2e5eecf 100644 --- a/baselineTexts/nhs-app-api.txt +++ b/baselineTexts/nhs-app-api.txt @@ -2,6 +2,9 @@ NHS App API Engage with users of the NHS App. +This specification is written from an OAS file. + +Get OAS file Page content Top of page Overview @@ -16,8 +19,8 @@ Onboarding Endpoints: Communication Send an in-app message Send a push notification -Get a daily communication event report Get details of NHS App users +Get a daily receipt report Overview Use this API to engage with users of the NHS App - a simple and secure way for patients registered with a GP surgery in England to access a range of services on their smartphone or tablet. @@ -51,11 +54,12 @@ For more details, see service levels. Technology -This API: +This API is RESTful. + +It conforms to the FHIR global standard for health care data exchange, specifically to FHIR R4 (v4.0.1), except that it does not support the capabilities interaction. + +It includes some country-specific FHIR extensions, which conform to FHIR UK Core, specifically fhir.r4.ukcore.stu1 0.5.1. -is RESTful -conforms to the FHIR global standard for health care data exchange -aligns with FHIR UK Core (which is built on FHIR Release 4) Specific rules for FHIR APIs FHIR APIs are RESTful APIs that follow specific rules. In particular: @@ -76,7 +80,7 @@ For more details see Network access for APIs. Security and authorisation -This API is application-restricted, meaning we authenticate the calling application but not the end user. In particular, the three FHIR CommunicationRequest endpoints use signed JWT authentication - you authenticate your application by sending a signed JSON web token (JWT) to our OAuth 2.0 authorisation server. For more details see Application-restricted RESTful APIs - signed JWT authentication. +This API is application-restricted, meaning we authenticate the calling application but not the end user. In particular, the two FHIR CommunicationRequest endpoints use signed JWT authentication - you authenticate your application by sending a signed JSON web token (JWT) to our OAuth 2.0 authorisation server. For more details see Application-restricted RESTful APIs - signed JWT authentication. After following these steps to create an application and register the public key, the App ID should be provided to the NHS App onboarding team to grant your application permissions to the features that are appropriate to your use cases. If this step is not completed, all calls to this API will return responses with status code 403 Forbidden. @@ -92,6 +96,7 @@ Our development environment: includes authorisation is for initial development and integration testing points to the Onboarding Sandpit NHS App environment, which in turn is using the NHS Login Sandpit environment +has a rate limit of 20 requests per second per application We have created a Postman collection during internal development and testing of the API, which you may find useful when working with this environment. @@ -104,9 +109,14 @@ Our integration test environment: includes authorisation is for formal release testing and assurance when onboarding with NHS Login points to the Onboarding AOS NHS App environment, which in turn is using the NHS Login Integration (AOS) environment +has a rate limit of 20 requests per second per application For more details see integration testing with our RESTful APIs. +Production + +Our production environment has a rate limit of 200 requests per second per application. + Onboarding You need to get your product or service approved by us before you can use this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. @@ -124,7 +134,6 @@ To onboard for this API, please get in touch with the NHS App onboarding team at Endpoints: Communication Send an in-app message POST /communication/in-app/FHIR/R4/CommunicationRequest -Try this API Overview Use this endpoint to send an in-app message followed by an associated native Apple or Android push notification to a single NHS App user. @@ -137,14 +146,14 @@ If a recipient is an active NHS App user but has not registered a device to rece This endpoint allows you to specify the content that will appear in the in-app message. It does not allow you to specify the content that will appear in the associated push notification. By default, the content of the associated push notification will read "NHS App. You have a new message." To discuss changing this standard push notification content for your application, contact the NHS App team. -We are considering an improvement that would include message sender names in associated push notifications. This may be of benefit if your application sends communications on behalf of several NHS organisations. You can track, comment, and vote for this feature on our interactive product backlog. - When a recipient taps the native notification, the NHS App will open on the in-app messaging inbox page. -We support a subset of Markdown for describing the body text of in-app messages. The length of each in-app message is limited to 5000 characters, including any markdown characters and embedded hyperlinks. +We support a subset of Markdown for describing the body text of in-app messages. For details of the subset see the 'payload' property of the schema. The length of each in-app message is limited to 5000 characters, including any markdown characters and embedded hyperlinks. The body of requests made to this endpoint are instances of HL7 FHIR R4 CommunicationRequest resources. This schema documentation describes which fields on that resource we require and support. The API is tolerant of (but will silently ignore) any additionally supplied optional fields. For example, we do not currently honour the doNotPerform or priority fields. +The outcome of communication requests can be determined using the daily receipt report endpoint or by subscribing to realtime receipts. + Request Headers Name Description @@ -193,16 +202,20 @@ Copy "payload" : [ { "contentString" : "You have a new appointment, please confirm you can attend. Open the Onboarded Third Party appointment [here](https://www.nhsapp.service.nhs.uk/appointments/hospital-appointments)" } ], - "sender" : { - "display" : "Onboarded Third Party" - }, "recipient" : [ { "type" : "Patient", "identifier" : { "system" : "https://fhir.nhs.uk/Id/nhs-number", "value" : "9903002157" } - } ] + } ], + "requester" : { + "type" : "Organization", + "identifier" : { + "system" : "https://fhir.nhs.uk/Id/ods-organization-code", + "value" : "B82041" + } + } } Schema Collapse all Expand all @@ -239,7 +252,7 @@ Note that these identifier system names are case-sensitive. The values provided The API will not reject requests that contain other identifier systems, but these values will be ignored and not recorded against the request. -When a CommunicationRequest resource is returned in the response body to a successful request, this array will also include a globally unique identifier assigned by the API, with the system urn:ietf:rfc:3986. This is the same logical ID contained within the Location header of the successful response. +When a CommunicationRequest resource is returned in the response body to a successful request, this array will also include a globally unique identifier assigned by the API, with the system https://fhir.nhs.uk/Id/nhs-app-communication-id. This is the same logical ID contained within the Location header of the successful response. @@ -262,24 +275,24 @@ The body text of the message to be displayed in the NHS App -sender -object +recipient +array required -The sender of the in-app message. +An array containing a single NHS number corresponding to the patient to whom this in-app message should be sent. Each communication may be sent to only a single recipient. +Min items: 1 +Max items: 1 -recipient -array +requester +object required -An array containing a single NHS number corresponding to the patient to whom this in-app message should be sent. Each communication may be sent to only a single recipient. +The requester who initiated the communication and would like to send an in-app message to the patient. -Max items: 1 -Min items: 1 Response HTTP status: 201 @@ -312,7 +325,7 @@ Copy { "resourceType" : "CommunicationRequest", "identifier" : [ { - "system" : "urn:ietf:rfc:3986", + "system" : "https://fhir.nhs.uk/Id/nhs-app-communication-id", "value" : "8f7ec136-66eb-4a9e-97ca-5c7a53d2710c" }, { "system" : "https://fhir.nhs.uk/NHSApp/campaign-id", @@ -331,8 +344,12 @@ Copy "value" : "9903002157" } } ], - "sender" : { - "display" : "Onboarded Third Party" + "requester" : { + "type" : "Organization", + "identifier" : { + "system" : "https://fhir.nhs.uk/Id/ods-organization-code", + "value" : "B82041" + } } } Schema @@ -360,7 +377,7 @@ array An array of identifiers used to identify this request. -This array will always include a globally unique identifier assigned by the API, with the system urn:ietf:rfc:3986. +This array will always include a globally unique identifier assigned by the API, with the system https://fhir.nhs.uk/Id/nhs-app-communication-id. It will include optional identifiers that were provided in the request if the API recognised the identifier system name. @@ -382,19 +399,19 @@ The body text of the message to be displayed in the NHS App. -sender -object +recipient +array -The sender of the in-app message. +An array containing a single NHS number corresponding to the patient to whom this in-app message was sent. -recipient -array +requester +object -An array containing a single NHS number corresponding to the patient to whom this in-app message was sent. +The requester who has sent the request for in-app message to the patient. HTTP status: 400 @@ -480,7 +497,7 @@ Copy } ] } -Multiple issues - sender name is missing and campaign ID exceed maximum length +Multiple issues - no recipient has been specified and campaign ID exceeds maximum length Copy { @@ -499,7 +516,20 @@ Copy "severity" : "error", "code" : "invalid", "diagnostics" : "Not specified", - "expression" : [ "sender.display" ] + "expression" : [ "recipient" ] + } ] +} + +The requester has an invalid identifier + +Copy +{ + "resourceType" : "OperationOutcome", + "issue" : [ { + "severity" : "error", + "code" : "invalid", + "diagnostics" : "Identifier system is invalid", + "expression" : [ "requester.identifier.system" ] } ] } Schema @@ -657,7 +687,7 @@ List of issues that have occurred. Min items: 1 HTTP status: 429 -You have exceeded your application's rate limit or the API is currently receiving a high volume of requests. +You have exceeded your application’s rate limit or the API is currently receiving a high volume of requests. Headers Name Description @@ -739,7 +769,6 @@ List of issues that have occurred. Min items: 1 Send a push notification POST /communication/notification/FHIR/R4/CommunicationRequest -Try this API Overview Use this endpoint to send a native Apple or Android push notifications to mobile devices registered by specific users of the NHS App. @@ -752,7 +781,7 @@ The body text of notifications can be up to 200 characters in length. They must not contain: -personally identifiable information (for example, the name of a user's doctor) +personally identifiable information (for example, the name of a user’s doctor) sensitive information (for example, details about a health condition) links to external websites @@ -760,6 +789,8 @@ You can also optionally specify a URL for a page within the NHS App to be opened The body of requests made to this endpoint are instances of HL7 FHIR R4 CommunicationRequest resources. This schema documentation describes which fields on that resource we require and support. The API is tolerant of (but will silently ignore) any additionally supplied optional fields. For example, we do not currently honour the doNotPerform or priority fields. +The outcome of communication requests can be determined using the daily receipt report endpoint or by subscribing to realtime receipts. + Request Headers Name Description @@ -854,7 +885,7 @@ Note that these identifier system names are case-sensitive. The values provided The API will not reject requests that contain other identifier systems, but these values will be ignored and not recorded against the request. -When a CommunicationRequest resource is returned in the response body to a successful request, this array will also include a globally unique identifier assigned by the API, with the system urn:ietf:rfc:3986. This is the same logical ID contained within the Location header of the successful response. +When a CommunicationRequest resource is returned in the response body to a successful request, this array will also include a globally unique identifier assigned by the API, with the system https://fhir.nhs.uk/Id/nhs-app-communication-id. This is the same logical ID contained within the Location header of the successful response. @@ -884,8 +915,8 @@ required An array containing a single NHS number corresponding to the patient to whom this push notification should be sent. Each communication may be sent to only a single recipient. -Max items: 1 Min items: 1 +Max items: 1 Response HTTP status: 201 @@ -918,7 +949,7 @@ Copy { "resourceType" : "CommunicationRequest", "identifier" : [ { - "system" : "urn:ietf:rfc:3986", + "system" : "https://fhir.nhs.uk/Id/nhs-app-communication-id", "value" : "54615138-df34-4a79-840d-dd07e9451519" }, { "system" : "https://fhir.nhs.uk/NHSApp/campaign-id", @@ -966,7 +997,7 @@ array An array of identifiers used to identify this request. -This array will always include a globally unique identifier assigned by the API, with the system urn:ietf:rfc:3986. +This array will always include a globally unique identifier assigned by the API, with the system https://fhir.nhs.uk/Id/nhs-app-communication-id. It will include optional identifiers that were provided in the request if the API recognised the identifier system name. @@ -1078,7 +1109,7 @@ Copy } ] } -Multiple issues - sender name is missing and campaign ID exceed maximum length +Multiple issues - no recipient has been specified and campaign ID exceeds maximum length Copy { @@ -1097,7 +1128,7 @@ Copy "severity" : "error", "code" : "invalid", "diagnostics" : "Not specified", - "expression" : [ "sender.display" ] + "expression" : [ "recipient" ] } ] } Schema @@ -1255,7 +1286,7 @@ List of issues that have occurred. Min items: 1 HTTP status: 429 -You have exceeded your application's rate limit or the API is currently receiving a high volume of requests. +You have exceeded your application’s rate limit or the API is currently receiving a high volume of requests. Headers Name Description @@ -1335,16 +1366,17 @@ array List of issues that have occurred. Min items: 1 -Get a daily communication event report -GET /communication/report/events -Try this API +Get details of NHS App users +GET /communication/report/patients Overview -Use this endpoint to get a daily report of events relating to in-app messages and push notifications that you have previously sent to NHS App users. +Use this endpoint to get details of patients registered with the NHS App for a given GP surgery, and an indication of whether they have enabled push notifications on one or more devices. The response will only include patients who have had their identity verified to 'high' (P9) level. -An event will be included in this report detailing the outcome of attempting to send each communication to each individual recipient, for each channel (push notification or in-app message). Additionally, for in-app messages only, an event will be included in this report if and when the recipient reads the message. +Client applications must only invoke this endpoint as agreed with the NHS App team, typically to retrieve details of patients at GP practices where their service is available. + +This information can be used by client applications to determine whether it is appropriate to attempt to use the NHS App API to send in-app messages and push notifications to patients, or if alternative communication channels should be used instead. -The information provided by this endpoint is generated by a daily batch process. Note that events in the report may pertain to communication requests that were submitted on earlier days. +The information provided by this endpoint is generated by a daily batch process. Client applications should cache and refresh local copies of this data accordingly. Pagination @@ -1353,13 +1385,15 @@ To avoid returning excessively large response bodies, the results may be split a Request Query parameters Name Description -day +ods-organisation-code -date (date) +String -The day for which to retrieve an event report. +The Organisation Data Service (ODS) code of the GP practice for which to retrieve a list of NHS App users. Not case sensitive. -Example: 2021-08-25 +Pattern: /^[A-Za-z]\\d{5}$|^[A-Za-z]\\d[A-Za-z]\\d[A-Za-z]$/ + +Example: Y00001 Required @@ -1425,68 +1459,11 @@ Example Copy [ { - "eventDateTime" : "2021-08-05T13:22:52+00:00", - "communicationId" : "a4d6af61-4302-48ab-b125-05daa8773836", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1234", - "channel" : "AppMessage", - "communicationCreatedDateTime" : "2021-08-05T13:20:52+00:00", - "event" : "Completed", - "eventDetail" : null -}, { - "eventDateTime" : "2021-08-05T18:32:52+00:00", - "communicationId" : "a4d6af61-4302-48ab-b125-05daa8773836", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1234", - "channel" : "PushNotification", - "communicationCreatedDateTime" : "2021-08-05T13:20:52+00:00", - "event" : "Completed", - "eventDetail" : null -}, { - "eventDateTime" : "2021-08-05T23:32:57+00:00", - "communicationId" : "fa1edc69-ab3b-46d0-b5a3-cbcc554e6707", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1235", - "channel" : "AppMessage", - "communicationCreatedDateTime" : "2021-08-05T23:32:52+00:00", - "event" : "Rejected", - "eventDetail" : "NHS number not found" -}, { - "eventDateTime" : "2021-08-05T13:38:52+00:00", - "communicationId" : "fa1edc69-ab3b-46d0-b5a3-cbcc554e6707", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1235", - "channel" : "PushNotification", - "communicationCreatedDateTime" : "2021-08-05T23:32:52+00:00", - "event" : "Rejected", - "eventDetail" : "NHS number not found" -}, { - "eventDateTime" : "2021-08-05T13:41:52+00:00", - "communicationId" : "df894b13-ae9f-4950-a06f-d36fefcf0f25", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1236", - "channel" : "AppMessage", - "communicationCreatedDateTime" : "2021-08-05T13:40:52+00:00", - "event" : "Completed", - "eventDetail" : null -}, { - "eventDateTime" : "2021-08-05T13:29:52+00:00", - "communicationId" : "4bed75b6-8dc8-4514-bf29-50737467a928", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1237", - "channel" : "AppMessage", - "communicationCreatedDateTime" : "2021-08-05T13:28:52+00:00", - "event" : "Read", - "eventDetail" : null + "nhsNumber" : "9074662803", + "notificationsEnabled" : true }, { - "eventDateTime" : "2021-08-05T13:51:52+00:00", - "communicationId" : "e732e542-e705-4210-9b72-5269e5e19d73", - "campaignId" : "Influenza_202108", - "requestReference" : "AN_1238", - "channel" : "AppMessage", - "communicationCreatedDateTime" : "2021-08-05T13:50:52+00:00", - "event" : "Read", - "eventDetail" : null + "nhsNumber" : "9903002157", + "notificationsEnabled" : false } ] Schema Collapse all Expand all @@ -1495,14 +1472,14 @@ Name Description array -An array of events relating to in-app messages and push notifications that you have previously sent to NHS App users. +An array of details of patients registered with the NHS App. object -A single event relating to an in-app message or push notification that your have previously sent to an NHS App user. +Details of a single patient registered with the NHS App. HTTP status: 400 @@ -1524,7 +1501,7 @@ Content type: application/fhir+json Examples -No day parameter has been specified +No ods-organisation-code parameter has been specified Copy { @@ -1533,11 +1510,11 @@ Copy "severity" : "error", "code" : "invalid", "diagnostics" : "Not specified", - "expression" : [ "day" ] + "expression" : [ "ods-organisation-code" ] } ] } -The supplied day parameter is not in the correct format. +The supplied ods-organisation-code parameter is not in the correct format. Copy { @@ -1546,7 +1523,7 @@ Copy "severity" : "error", "code" : "invalid", "diagnostics" : "Invalid format", - "expression" : [ "day" ] + "expression" : [ "ods-organisation-code" ] } ] } Schema @@ -1648,7 +1625,7 @@ List of issues that have occurred. Min items: 1 HTTP status: 403 -You are not authorised to perform this operation. Some client applications may not be permitted to access the event report endpoint. To discuss granting your application access to this endpoint, contact the NHS App team. +You are not authorised to perform this operation. Some client applications may not be permitted to access the patient report endpoint. To discuss granting your application access to this endpoint, contact the NHS App team. Headers Name Description @@ -1672,7 +1649,7 @@ Copy "issue" : [ { "severity" : "error", "code" : "security", - "diagnostics" : "Supplier with ID cdd248b8-cefb-404e-8da4-b79de3a9062a does not have event report access permission" + "diagnostics" : "Supplier with ID e55091c0-1991-4a3f-b1fc-cec1928633ec does not have patient report access permission" } ] } Schema @@ -1704,7 +1681,7 @@ List of issues that have occurred. Min items: 1 HTTP status: 429 -You have exceeded your application's rate limit or the API is currently receiving a high volume of requests. +You have exceeded your application’s rate limit or the API is currently receiving a high volume of requests. Headers Name Description @@ -1784,35 +1761,38 @@ array List of issues that have occurred. Min items: 1 -Get details of NHS App users -GET /communication/report/patients -Try this API +Get a daily receipt report +GET /communication/report/receipts/FHIR/R4/Task Overview -Use this endpoint to get details of patients registered with the NHS App for a given GP surgery, and an indication of whether they have enabled push notifications on one or more devices. The response will only include patients who have had their identity verified to 'high' (P9) level. +Use this endpoint to get a daily report of receipts relating to in-app messages and push notifications that you have sent to NHS App users. -Client applications must only invoke this endpoint as agreed with the NHS App team, typically to retrieve details of patients at GP practices where their service is available. +This report will include receipts detailing the outcome of an attempt to send each communication. For in-app messages, a receipt will also be included in this report if the recipient reads the message. -This information can be used by client applications to determine whether it is appropriate to attempt to use the NHS App API to send in-app messages and push notifications to patients, or if alternative communication channels should be used instead. +The following five types of receipt may be included in this response: -The information provided by this endpoint is generated by a daily batch process. Client applications should cache and refresh local copies of this data accordingly. +Rejected – a request to send a communication was rejected. For example, this could happen if the NHS number of the intended recipient does not correspond to an NHS App user. +Delivered – an in-app message has been successfully added to a user’s inbox. +Notified – a push notification is reported as having been successfully relayed to one or more native devices. +Unnotified – it has been determined that a push notification has not been successfully relayed to any native devices. +Read – a user has read an in-app message for the first time. + +In addition to this daily report endpoint, we also plan to offer the ability for onboarded partners to receive these receipts in realtime by having us push individual Task resources to an endpoint that you make available to us for this purpose. We call this feature "real-time receipts". Contact the NHS App team for additional information on how to subscribe to real-time receipts. Pagination -To avoid returning excessively large response bodies, the results may be split across multiple pages. On retrieving the response for the first page of results, the Link header should be inspected to determine whether any additional pages of results exist. If so, these can be retrieved by making additional request(s) with the optional page parameter specified. +To avoid returning excessively large response bodies, the results may be split across multiple pages. On retrieving the response for the first page of results, the Link header or Link array in the response body should be inspected to determine whether any additional pages of results exist. If so, these can be retrieved by making additional request(s) with the optional page parameter specified. Request Query parameters Name Description -ods-organisation-code - -String +day -The Organisation Data Service (ODS) code of the GP practice for which to retrieve a list of NHS App users. Not case sensitive. +date (date) -Pattern: /^[A-Za-z]\\d{5}$|^[A-Za-z]\\d[A-Za-z]\\d[A-Za-z]$/ +The day for which to retrieve a receipt report. -Example: Y00001 +Example: 2022-08-22 Required @@ -1877,29 +1857,221 @@ Content type: application/json Example Copy -[ { - "nhsNumber" : "9074662803", - "notificationsEnabled" : true -}, { - "nhsNumber" : "9903002157", - "notificationsEnabled" : false -} ] +{ + "resourceType" : "Bundle", + "type" : "searchset", + "total" : 7, + "link" : [ { + "relation" : "self", + "url" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task?day=2022-08-19&page=1" + }, { + "relation" : "last", + "url" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task?day=2022-08-19&page=1" + } ], + "entry" : [ { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/b2ac2ae7-1a24-4e90-8f3f-9a62c6ebb4e7", + "resource" : { + "id" : "b2ac2ae7-1a24-4e90-8f3f-9a62c6ebb4e7", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "https://fhir.nhs.uk/NHSApp/campaign-id", + "value" : "optional campaign id" + }, { + "system" : "https://fhir.nhs.uk/NHSApp/request-id", + "value" : "optional request reference" + }, { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "882cc757-5096-4565-9779-af25a751a65f" + } ], + "status" : "completed", + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Delivered" + } ] + }, + "authoredOn" : "2022-08-19T09:15:12+00:00", + "lastModified" : "2022-08-19T09:15:56+00:00" + } + }, { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/a762b523-4e04-4a47-8cdb-e28b06dd3ea1", + "resource" : { + "id" : "a762b523-4e04-4a47-8cdb-e28b06dd3ea1", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "https://fhir.nhs.uk/NHSApp/campaign-id", + "value" : "optional campaign id" + }, { + "system" : "https://fhir.nhs.uk/NHSApp/request-id", + "value" : "optional request reference" + }, { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "882cc757-5096-4565-9779-af25a751a65f" + } ], + "status" : "completed", + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Notified" + } ] + }, + "authoredOn" : "2022-08-19T09:15:12+00:00", + "lastModified" : "2022-08-19T09:16:02+00:00" + } + }, { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/71fedfbc-d1c9-4342-8ee0-b8201b15f28f", + "resource" : { + "id" : "71fedfbc-d1c9-4342-8ee0-b8201b15f28f", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "https://fhir.nhs.uk/NHSApp/campaign-id", + "value" : "optional campaign id" + }, { + "system" : "https://fhir.nhs.uk/NHSApp/request-id", + "value" : "optional request reference" + }, { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "882cc757-5096-4565-9779-af25a751a65f" + } ], + "status" : "completed", + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Read" + } ] + }, + "authoredOn" : "2022-08-19T09:15:12+00:00", + "lastModified" : "2022-08-19T09:38:17+00:00" + } + }, { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/8c241d11-8957-4148-a298-0df6ffcb5521", + "resource" : { + "id" : "8c241d11-8957-4148-a298-0df6ffcb5521", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "410baa9d-0b7e-4120-af1b-2f5b2656edf9" + } ], + "status" : "completed", + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Delivered" + } ] + }, + "authoredOn" : "2022-08-19T11:51:05+00:00", + "lastModified" : "2022-08-19T11:51:07+00:00" + } + }, { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/f2c5b23f-387c-4c9e-87c9-346bd8bd9f03", + "resource" : { + "id" : "f2c5b23f-387c-4c9e-87c9-346bd8bd9f03", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "410baa9d-0b7e-4120-af1b-2f5b2656edf9" + } ], + "status" : "completed", + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Unnotified" + } ] + }, + "authoredOn" : "2022-08-19T11:51:05+00:00", + "lastModified" : "2022-08-19T11:51:34+00:00" + } + }, { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/0dc3ba21-ec8f-4d93-a74b-0d717c186dbe", + "resource" : { + "id" : "0dc3ba21-ec8f-4d93-a74b-0d717c186dbe", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "410baa9d-0b7e-4120-af1b-2f5b2656edf9" + } ], + "status" : "completed", + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Read" + } ] + }, + "authoredOn" : "2022-08-19T11:51:05+00:00", + "lastModified" : "2022-08-19T13:17:30+00:00" + } + }, { + "fullUrl" : "https://api.service.nhs.uk/nhs-app/communication/report/events/FHIR/R4/Task/46fb07d6-e679-4ff8-97af-538935a707a3", + "resource" : { + "id" : "46fb07d6-e679-4ff8-97af-538935a707a3", + "resourceType" : "Task", + "intent" : "order", + "identifier" : [ { + "system" : "https://fhir.nhs.uk/NHSApp/campaign-id", + "value" : "flu campaign 202208" + }, { + "system" : "http://fhir.nhs.uk/Id/nhs-app-communication-id", + "value" : "01389fa3-2cb9-4440-b075-c4902b526fbc" + } ], + "status" : "rejected", + "statusReason" : { + "text" : "NHS number not found" + }, + "code" : { + "coding" : [ { + "system" : "https://fhir.nhs.uk/CodeSystem/NHSApp-Communication-Status", + "code" : "Rejected" + } ] + }, + "authoredOn" : "2021-08-19T15:20:52+00:00", + "lastModified" : "2021-08-19T15:20:56+00:00" + } + } ] +} Schema Collapse all Expand all Name Description -array +object +Bundle resource containing tasks -An array of details of patients registered with the NHS App. +A bundle resource containing tasks representing receipts relating to in-app messages and push notifications that you have previously sent to NHS App users. -object +resourceType +string +required +Allowed values: Bundle + + +type +string +required + +Allowed values: searchset + + +link +array +required + +Min items: 1 +Max items: 3 -Details of a single patient registered with the NHS App. +entry +array +required + HTTP status: 400 There is an error in your request. @@ -1920,7 +2092,7 @@ Content type: application/fhir+json Examples -No ods-organisation-code parameter has been specified +No day parameter has been specified Copy { @@ -1929,11 +2101,11 @@ Copy "severity" : "error", "code" : "invalid", "diagnostics" : "Not specified", - "expression" : [ "ods-organisation-code" ] + "expression" : [ "day" ] } ] } -The supplied ods-organisation-code parameter is not in the correct format. +The supplied day parameter is not in the correct format. Copy { @@ -1942,7 +2114,7 @@ Copy "severity" : "error", "code" : "invalid", "diagnostics" : "Invalid format", - "expression" : [ "ods-organisation-code" ] + "expression" : [ "day" ] } ] } Schema @@ -2044,7 +2216,7 @@ List of issues that have occurred. Min items: 1 HTTP status: 403 -You are not authorised to perform this operation. Some client applications may not be permitted to access the patient report endpoint. To discuss granting your application access to this endpoint, contact the NHS App team. +You are not authorised to perform this operation. Some client applications may not be permitted to access the receipt report endpoint. To discuss granting your application access to this endpoint, contact the NHS App team. Headers Name Description @@ -2068,7 +2240,7 @@ Copy "issue" : [ { "severity" : "error", "code" : "security", - "diagnostics" : "Supplier with ID e55091c0-1991-4a3f-b1fc-cec1928633ec does not have patient report access permission" + "diagnostics" : "Supplier with ID cdd248b8-cefb-404e-8da4-b79de3a9062a does not have Receipts report access permission" } ] } Schema @@ -2100,7 +2272,7 @@ List of issues that have occurred. Min items: 1 HTTP status: 429 -You have exceeded your application's rate limit or the API is currently receiving a high volume of requests. +You have exceeded your application’s rate limit or the API is currently receiving a high volume of requests. Headers Name Description @@ -2179,4 +2351,6 @@ array List of issues that have occurred. -Min items: 1 \ No newline at end of file +Min items: 1 + +Last edited: 4 October 2022 2:55 pm \ No newline at end of file diff --git a/baselineTexts/nhs-booking-fhir-api.txt b/baselineTexts/nhs-booking-fhir-api.txt index b589b6b..6237277 100644 --- a/baselineTexts/nhs-booking-fhir-api.txt +++ b/baselineTexts/nhs-booking-fhir-api.txt @@ -15,9 +15,9 @@ Environments and testing Onboarding Interactions -This API will be retired in 12 to 18 months from March 2022.  The Booking and Referral Standard (BaRS) will replace it. +This API is deprecated and will be retired in 12 to 18 months from March 2022.  The Booking and Referral Standard (BaRS) will replace it.  We will contact you before we agree to a retirement date. -The current API is still available for existing development, but not for new integrations.  For more details, contact the Booking and referral team. +This API is still available for existing development, but not for new integrations.  For more details, contact the Booking and referral team. Overview @@ -29,7 +29,7 @@ This API can only be used where there is a legal basis to do so. Make sure you h API status -This API is stable but under review. +This API is deprecated. This API will be retired in 12 to 18 months from March 2022.   @@ -65,8 +65,7 @@ You can find out more about environments and testing here. Onboarding -This API will be retired in 12 to 18 months from March 2022.  - +This API is deprecated and will be retired in 12 to 18 months from March 2022.  It is being replaced by the Booking and Referral Standard (BaRS). You need to contact us at bookingandreferralstandard@nhs.net before you can use this API. Interactions @@ -87,4 +86,4 @@ Alpha FHIR NHS Scheduling 1.0.2 Alpha November 2018 Search for free slots, book For more details on the specifics of this use case, see Urgent & Emergency Care Appointment Booking -Last edited: 26 May 2022 4:23 pm \ No newline at end of file +Last edited: 9 September 2022 9:19 am \ No newline at end of file diff --git a/baselineTexts/nhs-continuing-healthcare-chc-patient-level-data-set.txt b/baselineTexts/nhs-continuing-healthcare-chc-patient-level-data-set.txt new file mode 100644 index 0000000..6faf99d --- /dev/null +++ b/baselineTexts/nhs-continuing-healthcare-chc-patient-level-data-set.txt @@ -0,0 +1,52 @@ +DCB3085: NHS Continuing Healthcare (NHS CHC) Patient-Level Data Set + +An information standard which sets out the rules for an end to end, patient level data set that captures data relating to patient details, NHS CHC eligibility, activity, reviews and care packages. + +Page contents +Top of page +About this information standard +Current release +Change control +About this information standard + +NHS Continuing Healthcare (NHS CHC) means a package of ongoing care that is arranged and funded solely by the NHS where the individual has been assessed and found to have a ‘primary health need’ as set out in the National Framework for NHS Continuing Healthcare and NHS-funded Nursing in England. + +This new standard, the NHS Continuing Healthcare (NHS CHC) Patient-Level Data Set, sets out the rules for an end to end, patient level data set that captures data relating to patient details, NHS CHC eligibility, activity, reviews and care packages. + +The existing NHS CHC quarterly collection of aggregate data (DCB2117) will continue to be submitted by providers as normal until the quality of data submitted in DCB3085 reaches an adequate level to allow the quarterly collection to be retired. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Release date 07/05/2020 +Release number Amd 51/2019 +Release title Initial Standard, Version 1.0 +Stage Implementation +Key documents +Information Standards Notice (Amd 51/2019) +Corrigendum (Amd 51/2019) (August 2021) +Second Corrigendum (Amd 51/2019) (September 2022) +Requirements Specification v1.1 (Amd 51/2019) (September 2022) +Data Set Specification v1.2 (Amd 51/2019) (September 2022) +Implementation Guidance v1.1 (Amd 51/2019) (September 2022) + +Supporting documents +NHS Data Model and Dictionary Change Request 1873 (Basic CR) (Amd 51/2019) (September 2022) +NHS Data Model and Dictionary Change Request 1873 (Data Set CR) (Amd 51/2019) (September 2022) +NHS Data Model and Dictionary Change Request 1829 (Basic CR) (Amd 51/2019) (August 2021) +NHS Data Model and Dictionary Change Request 1829 (Data Set CR) (Amd 51/2019) (August 2021) +XML schema (external link) + +Further information + +More guidance is available on the NHS Digital website + +Change control + +28 September 2022: Publication for Corrigendum in respect of Version 1.0, supported by changes to the Data Set Specification (uplifted to document version 1.2) and to the Requirements Specification and Implementation Guide (uplifted to document version 1.1). See Corrigendum above for full details. + +31 August 2021: Publication of Corrigendum in respect of Version 1.0, supported by changes to the Data Set Specification (uplifted to document version 1.1). See Corrigendum above for full details. + +27 April 2021: At the time of publication of version 1.0 of DCB3085 (7 May 2020) the implementation and conformance dates of this standard were noted by the DCB as being subject to change depending on the need for continuing frontline investment in COVID-19 activity. The implementation and conformance dates have been extended by 12 months and the implementation completion date is now 1 April 2022 with full conformance expected by 31 May 2022, in line with the submission of the April 2022 reporting activity. The Requirements Specification and Implementation Guidance have been updated to reflect this. + +Last edited: 28 September 2022 11:01 pm \ No newline at end of file diff --git a/baselineTexts/opcs-classification-of-interventions-and-procedures.txt b/baselineTexts/opcs-classification-of-interventions-and-procedures.txt index c454d8a..8fbdb44 100644 --- a/baselineTexts/opcs-classification-of-interventions-and-procedures.txt +++ b/baselineTexts/opcs-classification-of-interventions-and-procedures.txt @@ -27,7 +27,7 @@ Release number Amd 18/2019 Release title Version 4.9 Stage Implementation Key documents -Requirements Specification (Amd 18/2019)   +Requirements Specification (Amd 18/2019) [Archive Content]   Change Specification (Amd 18/2019) Implementation Guidance (Amd 18/2019) Information Standards Notice (Amd 18/2019) @@ -44,7 +44,7 @@ Release number Amd 105/2015 Release title Version 4.8 Stage Maintenance Key documents -Requirements Specification (Amd 105/2015)  +Requirements Specification (Amd 105/2015) [Archive Content]  Change Paper (Amd 105/2015) Implementation Guidance (Amd 105/2015) Information Standards Notice (Amd 105/2015) diff --git a/baselineTexts/outpatient-letter.txt b/baselineTexts/outpatient-letter.txt index f598204..adcfc55 100644 --- a/baselineTexts/outpatient-letter.txt +++ b/baselineTexts/outpatient-letter.txt @@ -31,7 +31,6 @@ Chartered Society of Physiotherapy Institute of Health Records and Information Managers (IHRIM) TechUK The standard -Outpatient letter standard Release Notes V2.1 @@ -42,14 +41,7 @@ V2.1 (Dec 2019) includes an update to: Previous revisions -Release notes – V2.0 -Release notes V1. Supporting documentation -Implementation guidance   -Final report -Safety case report -Hazard log – excel file -Transfer of care FHIR specifications IHRIM record correction guidance Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. diff --git a/baselineTexts/paediatric-critical-care-minimum-data-set.txt b/baselineTexts/paediatric-critical-care-minimum-data-set.txt new file mode 100644 index 0000000..301d865 --- /dev/null +++ b/baselineTexts/paediatric-critical-care-minimum-data-set.txt @@ -0,0 +1,33 @@ +SCCI0076: Paediatric Critical Care Minimum Data Set (version 2) + +The primary purpose of the PCCMDS is to allow the operation of the National Tariff Payment System (NTPS) within paediatric critical care. + +Page contents +Top of page +About this information standard +Releases +About this information standard + +The Paediatric Critical Care Minimum Data Set (PCCMDS) provides a record of what happens to a patient when they receive paediatric critical care in a Paediatric Intensive Care Unit (PICU) or other critical care setting suitable for children. Version 1.0 of the PCCMDS was introduced in April 2007. + +The primary purpose of the PCCMDS is to allow the operation of the National Tariff Payment System (NTPS) within paediatric critical care. It supports the NTPS by specifying and facilitating the capture of data needed to generate a Healthcare Resource Group (HRG) for each calendar day (or part thereof) of a period of paediatric critical care. + +This information standard is maintained by the National Casemix Office within NHS Digital. It is related to SCCI0075 Neonatal Critical Care Minimum Data Set, in that it shares common fields and values, including an agreed list of Critical Care Activity Codes. + +An Information Standards Notice (see release table below) provides an overview of scope and implementation timescales, and the Specification and Implementation Documents provide further detail for those who have to implement the information standard. + +Releases +Release date 07/09/2016 +Release number Amd 113/2015 +Release title Version 2.0 +Stage Implementation +Key documents +Requirements Specification (Amd 113/2015) +Implementation Guidance (Amd 113/2015) [Archive Content] +Change Specification (Amd 113/2015) +Information Standards Notice (Amd 113/2015) + +Supporting documents +NHS Data Model and Dictionary Change 1545 changes (Amd 113/2015) + +Last edited: 5 November 2018 10:55 am \ No newline at end of file diff --git a/baselineTexts/palliative-care-co-ordination-core-content.txt b/baselineTexts/palliative-care-co-ordination-core-content.txt index 1fe9bc4..267568b 100644 --- a/baselineTexts/palliative-care-co-ordination-core-content.txt +++ b/baselineTexts/palliative-care-co-ordination-core-content.txt @@ -32,10 +32,10 @@ Release number Amd 11/2015 Release title Version 4.0 Stage Implementation Key documents -Requirements Specification (Amd 11/2015) -Implementation Guidance (Amd 11/2015) -Change Specification (Amd 11/2015) -Implementing the Changes (Amd 11/2015) +Requirements Specification (Amd 11/2015) [Archive Content] +Implementation Guidance (Amd 11/2015) [Archive Content] +Change Specification (Amd 11/2015) [Archive Content] +Implementing the Changes (Amd 11/2015) [Archive Content] Information Standards Notice (Amd 11/2015) Corrigendum (Amd 11/2015) @@ -45,7 +45,7 @@ Record Keeping Guidance (Amd 11/2015) Clinical Hazard Log Final (Amd 11/2015) NHS Data Model and Dictionary Change Request 1521 (Amd 11/2015) -EPACCS IT System Requirements (Amd 11/2015) +EPACCS IT System Requirements (Amd 11/2015) [Archive Content] Further information PHE - National End of Life Care Intelligence Network diff --git a/baselineTexts/pathology-messaging-edifact-api.txt b/baselineTexts/pathology-messaging-edifact-api.txt index 82dfcbd..70bcf38 100644 --- a/baselineTexts/pathology-messaging-edifact-api.txt +++ b/baselineTexts/pathology-messaging-edifact-api.txt @@ -1,13 +1,13 @@ -Pathology Messaging - EDIFACT API +Pathology Messaging - EDIFACT Receive pathology test results in GP practices from laboratories. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -15,42 +15,61 @@ Security and authorisation Environments and testing Onboarding Interactions + +This integration is in production, but under review for deprecation.  + +If you are developing a new integration, consider using the Pathology Messaging - FHIR integration instead. + +If you have any concerns, contact us. + Overview +send test results +Pathology system +MESH +GP system +receive test results -Use this API to receive pathology test results in GP practices from laboratories. +  -It's designed for the transmission of structured pathology results from pathology laboratories to primary care GP systems, using UN/EDIFACT based messages over MESH.  +Use this integration to receive structured pathology test results in GP practices from pathology laboratories. + +This integration uses MESH to send and receive UN/EDIFACT based messages.  For more details, see the Pathology EDIFACT v1.003 Standard. If you are building a system to receive pathology test results, you can use our Lab Results adaptor to receive these EDIFACT results via an easy-to-use FHIR-compliant format.  -Before you begin any development work using this API, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below). Related APIs -The following screening APIs are related to this one: +The following API is related to this integration: + +Message Exchange for Social Care and Health (MESH) API - use this API to transfer messages and large files securely across health and social care organisations + +The following screening integrations are similar to this one: -Bowel Cancer Screening - EDIFACT API - use this to receive bowel cancer screening test results in GP practices from the screening system using EDIFACT messages sent over MESH -API status +Bowel Cancer Screening - EDIFACT - use this to receive bowel cancer screening test results in GP practices from the screening system using EDIFACT messages sent over MESH +Cervical Screening - EDIFACT - use this to receive cervical screening test results in GP practices from the screening system using EDIFACT messages sent over MESH +Status -This API is stable. +This integration is in production, but under review for deprecation.  Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This is an asynchronous messaging API. Messages are: +This integration uses asynchronous messaging. Messages are: formatted as EDIFACT sent and received via MESH @@ -63,7 +82,7 @@ If you are building a system to receive pathology test results, you can use our Network access -You can access this API via: +You can access this integration via: the Health and Social Care Network (HSCN) the internet @@ -72,15 +91,15 @@ For more details see Network access for APIs. Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -The API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +The integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. Environments and testing -This API uses MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. +This integration uses MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. For more details about using the MESH client, see MESH client. @@ -90,14 +109,14 @@ Onboarding You must get your software onboarded before it can go live. The onboarding process can sometimes be quite long, so it's worth planning well ahead. -This API has a specific onboarding process for new market entrant GP IT developers. This applies whether you are integrating with it directly or using our Lab results adaptor. Contact your GP IT delivery lead for more details. +This integration has a specific onboarding process for new market entrant GP IT developers. This applies whether you are integrating with it directly or using our Lab results adaptor. Contact your GP IT delivery lead for more details. For other use cases, contact us. Interactions -For a full list of interactions for this API, see ISB 1557 EDIFACT Pathology Messaging. +For a full list of interactions for this integration, see ISB 1557 EDIFACT Pathology Messaging. You can also use our Lab Results adaptor to receive these EDIFACT results via an easy-to-use FHIR-compliant format.  -Last edited: 26 May 2022 4:29 pm \ No newline at end of file +Last edited: 13 October 2022 1:12 pm \ No newline at end of file diff --git a/baselineTexts/pathology-messaging-fhir-api.txt b/baselineTexts/pathology-messaging-fhir-api.txt index a7cb31e..fa0cab9 100644 --- a/baselineTexts/pathology-messaging-fhir-api.txt +++ b/baselineTexts/pathology-messaging-fhir-api.txt @@ -1,13 +1,13 @@ -Pathology Messaging - FHIR API +Pathology Messaging - FHIR Share pathology results from a Laboratory Information Management System (LIMS) to the requestor in NHS primary or secondary care settings. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -15,56 +15,69 @@ Security and authorisation Environments and testing Onboarding Interactions - -This API is not available in production. If you are developing a new integration, consider using the Pathology Messaging - EDIFACT API. For details see, API status. - Overview - -Use this API to share pathology results from a Laboratory Information Management System (LIMS) to the requestor, typically a healthcare worker in NHS primary or secondary care. +Pathology  system +MESH +NHS healthcare system +4. receive pathology +results message +1. send request for +pathology results +3. send pathology +results message +2. receive request for +pathology results + +  + +Use this integration to share pathology results from a Laboratory Information Management System (LIMS) to the requestor, typically a healthcare worker in NHS primary or secondary care. Initially it focuses on haematology and clinical biochemistry test reporting - also known as chemical pathology. +This integration uses MESH to send and receive pathology results. + It is intended to replace the current Pathology Messaging - EDIFACT API and supersedes Laboratory HL7 V3 (see the Message Implementation Manual under Domains -> Health and Clinical Management -> Laboratory). -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below). Related APIs -The following APIs are also related to this API: +The following APIs and integrations are also related to this integration: -Message Exchange for Social Care and Health (MESH) API - use this API to transfer messages securely across health and social care organisations +Message Exchange for Social Care and Health (MESH) API - use this to transfer messages securely across health and social care organisations -Pathology Messaging - HL7 V3 API - use this API to request NHS Newborn Blood Spot (NBS) laboratory tests and send the results back to the requester, using our client side MHS adaptor that you can integrate into your own infrastructure +Pathology Messaging - HL7 V3 API - use this to request NHS Newborn Blood Spot (NBS) laboratory tests and send the results back to the requester, using our client side MHS adaptor that you can integrate into your own infrastructure -Pathology Messaging - EDIFACT API - use this API to send pathology results from pathology laboratories to the requestor, using UN/EDIFACT based messages sent over MESH +Pathology Messaging - EDIFACT - use this to send pathology results from pathology laboratories to the requestor, using UN/EDIFACT based messages sent over MESH -Additionally, use the following API standard to implement this API: +Cervical Screening - EDIFACT - use this to receive cervical screening test results in GP practices from the screening system using EDIFACT messages sent over MESH -Interoperability Toolkit 3 Messaging Distribution FHIR API standards - use this API standard to implement a set of generic messaging components using HL7 FHIR STU3 to create a unified approach to NHS message and document flows across England +Additionally, use the following API standard to implement this integration: -API status +Interoperability Toolkit 3 Messaging Distribution FHIR API standards - use this API standard to implement a set of generic messaging components using HL7 FHIR STU3 to create a unified approach to NHS message and document flows across England +Status -This API is experimental - an early pre-alpha version under development. +This integration is not available in production and is experimental - an early pre-alpha version under development. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This is an asynchronous messaging API. The messages take the form of FHIR STU3 messages sent via MESH. +This integration uses asynchronous messaging. The messages take the form of FHIR STU3 messages sent via MESH. For more details, see FHIR and MESH. Network access -You can access this API via: +You can access this integration via: the Health and Social Care Network (HSCN) @@ -74,15 +87,15 @@ For more details see Network access for APIs. Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -The API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +The integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. Environments and testing -This API uses MESH. +This integration uses MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. @@ -92,10 +105,10 @@ For the MESH API, there are several independent, externally accessible instances Onboarding -This API is not available for onboarding yet. +This integration is not available for onboarding yet. Interactions -For a full list of interactions for this API, see National Pathology FHIR Messaging Specifications. +For a full list of interactions for this integration, see National Pathology FHIR Messaging Specifications. -Last edited: 26 May 2022 3:02 pm \ No newline at end of file +Last edited: 23 August 2022 11:17 am \ No newline at end of file diff --git a/baselineTexts/pathology-messaging-hl7-v3-api.txt b/baselineTexts/pathology-messaging-hl7-v3-api.txt index 34f57f9..152ceec 100644 --- a/baselineTexts/pathology-messaging-hl7-v3-api.txt +++ b/baselineTexts/pathology-messaging-hl7-v3-api.txt @@ -1,13 +1,13 @@ -Pathology Messaging - HL7 V3 API +Pathology Messaging - HL7 V3 Request laboratory tests and send the results back to the requester, usually the patient's GP or consultant. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network Access @@ -17,43 +17,45 @@ Onboarding Interactions Overview -Use this API to request laboratory tests and send the results back to the requester, usually the patient's GP or consultant. Results can also be copied to other healthcare providers for information. +Use this integration to request laboratory tests and send the results back to the requester, usually the patient's GP or consultant. Results can also be copied to other healthcare providers for information. One request can lead to several results reports and each report is complete in its own right. If incomplete reports are issued, a final report carries all the reported information, replacing the originals entirely. -This API is not widely adopted - it is only used as part of the NHS Newborn Blood Spot (NBS) Screening Programme which involves a limited number of pathology laboratories. Pathology Messaging - EDIFACT API supports most of the pathology interactions. +This integration is not widely adopted - it is only used as part of the NHS Newborn Blood Spot (NBS) Screening Programme which involves a limited number of pathology laboratories. Pathology Messaging - EDIFACT API supports most of the pathology interactions. -This API will be superseded by the Pathology Messaging - FHIR API. +This integration will be superseded by the Pathology Messaging - FHIR API. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below). Related APIs -The following APIs are also related to this API: +The following APIs and integrations are similar to this one: -Message Exchange for Social Care and Health (MESH) API - use this API to transfer messages securely across health and social care organisations +Digital Child Heath - FHIR API - use this API to create, update or delete a record of a blood spot test outcome, newborn hearing test or Newborn and Infant Physical Examination (NIPE) outcome -Pathology Messaging - EDIFACT API - use this API to send pathology results from pathology laboratories to the requestor, using UN/EDIFACT based messages sent over MESH +Message Exchange for Social Care and Health (MESH) API - use this to transfer messages securely across health and social care organisations -Pathology Messaging - FHIR API - use this API to request chemical pathology results from a Laboratory Information Management System (LIMS) to NHS primary or secondary care settings. +Pathology Messaging - EDIFACT - use this to send pathology results from pathology laboratories to the requestor, using UN/EDIFACT based messages sent over MESH -API status +Pathology Messaging - FHIR - use this to request chemical pathology results from a Laboratory Information Management System (LIMS) to NHS primary or secondary care settings. -This API is stable and has been in a V1.2 draft state since 2008.  +Status + +This integration is in production and has been in a V1.2 draft state since 2008.  Service level -This API is a platinum service, meaning it is operational and supported 24 x 7 x 365. +This integration is a platinum service, meaning it is operational and supported 24 x 7 x 365. For more details, see service levels. Technology -This API is an HL7 V3 API and uses asynchronous interactions, using HL7 V3 ebXML messaging. +This integration meets HL7 V3 standard and uses asynchronous interactions, using HL7 V3 ebXML messaging. For more details, see HL7 V3. @@ -65,14 +67,14 @@ It makes it easier to connect to the NHS Spine and perform business operations b Network Access -You need a Health and Social Care Network (HSCN) connection to use this API. +You need a Health and Social Care Network (HSCN) connection to use this integration. For more details, see Network access for APIs. Security and authorisation Authentication -This API is user-restricted, meaning an end user must be present and authenticated to use it. +This integration is user-restricted, meaning an end user must be present and authenticated to use it. The end user must be: @@ -86,22 +88,22 @@ Authorisation For some activities, the end user must be authorised to perform that activity. -The API itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. +The integration itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database. For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page. Environments and testing -In order to perform end-to-end testing with the MHS Adaptor, you will require access to NHS Digital’s Path to Live environments. +To perform end-to-end testing with the MHS Adaptor, you need access to NHS Digital’s Path to Live environments. Onboarding You must get your software onboarded before it can go live. -Contact us before onboarding with this API. It uses the Common Assurance Process (CAP) which is tailored for each NHS service. +Contact us before onboarding with this integration. It uses the Common Assurance Process (CAP) which is tailored for each NHS service. Interactions -For a full list of interactions for this API, see the Laboratory section in the Spine Message Implementation Manual (MIM).  +For a full list of interactions for this integration, see the Laboratory section in the Spine Message Implementation Manual (MIM).  -Last edited: 26 May 2022 4:28 pm \ No newline at end of file +Last edited: 14 October 2022 7:31 am \ No newline at end of file diff --git a/baselineTexts/patient-level-contract-monitoring.txt b/baselineTexts/patient-level-contract-monitoring.txt new file mode 100644 index 0000000..cbdf1fe --- /dev/null +++ b/baselineTexts/patient-level-contract-monitoring.txt @@ -0,0 +1,152 @@ +Contract Monitoring + +A set of four information standards for Contract Monitoring to enable national consistency of the flow of cost and activity information from providers to commissioners. + +Page contents +Top of page +About this information standard +Current releases +Previous releases +Updates +About this information standard + +The Contract Monitoring information standards are a set of standards being introduced by NHS England and NHS Improvement to enable national consistency of the flow of cost and activity information from providers to commissioners. The standards are: + +DCB2050 Aggregate Contract Monitoring  +DCB3003 Patient Level Contract Monitoring +DCB3002 Devices Patient Level Contract Monitoring +DCB2212 Drugs Patient Level Contract Monitoring. + +Having national standards to support contract monitoring will: + +reduce burden +allow simpler and more consistent reporting +allow easier reconciliation and validation of invoices +provide support for service change planning and hospital capacity analysis +improve forecasting +allow greater monitoring of equity of access to services. + +These information standards are published under section 250 of the Health and Social Care Act 2012.  An Information Standards Notice for each standard (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standards. Note that while the NHS Data Model and Dictionary documents are listed under each standard, they are consolidation documents encompassing all four standards. + +Additional guidance documentation is available on the NHS England website: https://www.england.nhs.uk/nhs-standard-contract/dc-reporting + +In the event of issues or questions about any of these standards, please contact the developers at NHS England and NHS Improvement: england.nccis@nhs.net. + +Future development of the standards + +The contract monitoring standards became national data standards in April 2021 and had an implementation date of September 2021 for reporting of activity in October 2021. + +Given the mid-year implementation date, it has been decided that there will be no alterations to these standards during 2021-22 or 2022-23 in order for reporting systems to bed-in and become mature. + +Consideration of suggested changes and/or developments to the four standards will start in 2022-23. Users may submit suggestions from April 2022 to england.nccis@nhs.net  + +Suggestions will be considered by a multi-disciplinary working party comprising representation from suitable relevant stakeholders during September-October 2022. Those suggested changes considered by the group to be essential or of merit will then go out to national consultation in December 2022 as required for all suggested changes to national data standards. + +Current releases +DCB2050 Aggregate Contract Monitoring (ACM) Version 2.0 +Release date 08/04/2021 +Release number Amd 73/2020 +Key documents +Change Specification (Amd 73/2020) +Requirements Specification (Amd 73/2020) +Implementation Guidance (Amd 73/2020) +Information Standards Notice (Amd 73/2020) + +Supporting documents +Technical Details Specification v2.1 (Amd 73/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 73/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 73/2020) +User Guidance v1.3 (Amd 73/2020) +DCB3003 Patient Level Contract Monitoring (PLCM) Version 2.0 +Release date  08/04/2021 +Release number Amd 76/2020 +Key documents  +Change Specification (Amd 76/2020) +Requirements Specification (Amd 76/2020) +Implementation Guidance (Amd 76/2020) +Information Standards Notice (Amd 76/2020) + +Supporting documents +Technical Details Specification v2.1 (Amd 76/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 76/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 76/2020)  +User Guidance v1.2 (Amd 76/2020) +DCB3002 Devices Patient Level Contract Monitoring (DePLCM) Version 2.0 +Release date 08/04/2021 +Release number Amd 75/2020 +Key documents +Change Specification (Amd 75/2020) +Requirements Specification (Amd 75/2020) +Implementation Guidance (Amd 75/2020) +Information Standards Notice (Amd 75/2020)  + +Supporting documents +Technical Details Specification v2.2 (Amd 75/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 75/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 75/2020)  +User Guidance v1.1 (Amd 75/2020) +DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM) Version 2.0 +Release date 08/04/2021 +Release number Amd 74/2020 +Key documents +Change Specification (Amd 74/2020) +Requirements Specification (Amd 74/2020) +Implementation Guidance (Amd 74/2020) +Information Standards Notice (Amd 74/2020) + +Supporting documents +Technical Details Specification v2.6 (Amd 74/2020) +NHS Data Model and Dictionary Change Request 1814 (Basic CR) (Amd 74/2020) +NHS Data Model and Dictionary Change Request 1814 (Data Set CR) (Amd 74/2020) +User Guidance v1.2 (Amd 74/2020)  +Previous releases + +Documents for earlier releases of the Contract Monitoring information standards can be viewed on our Contract Monitoring archive page. + +Updates + +11 October 2022: Minor changes have been made to the user guidance for clarification, for contract monitoring standards DCB2050 Aggregate Contract Monitoring (ACM) (see section 7 and section 8 (FAQs) Q16) and DCB3003 Patient Level Contract Monitoring (PLCM) (see section 8 (FAQs) Q8).  + +There has also been a minor change made to the Technical Details Specification document for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy reference table, which now matches the latest (v17.2) list of medicines not reimbursed through national prices that are directly commissioned by NHS England. + +  + +8 July 2022: A minor change has been made to the Technical Details Specification document for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy reference table, which now matches the latest (v17.1) list of medicines not reimbursed through national prices that are directly commissioned by NHS England. + +  + +12 May 2022: A minor change has been made to the Technical Details Specification documents for each of the contract monitoring standards (DCB2050 Aggregate Contract Monitoring (ACM), DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM), DCB3002 Devices Patient Level Contract Monitoring (DePLCM) and DCB3003 Patient Level Contract Monitoring (PLCM)). This update relates to the addition of a new code (code 32) in the Commissioned Service Category Code reference table of each document, to accommodate the forthcoming introduction of the NHS England Innovative Medicines Fund. + +There has also been a further change to the Technical Details Specification document for DCB3002 Devices Patient Level Contract Monitoring (DePLCM), with an update to the device taxonomy reference table. This change has been made as in the final 2022/23 tariff guidance the Stent Retriever (DEV54) category was combined into the Mechanical Thrombectomy category (DEV51) and as such the code DEV54 for Stent Retriever is not required separately. The Mechanical Thrombectomy category (DEV51) has been renamed as “Mechanical Thrombectomy Stent Retrievers and Clot Retrievers” as per the National Tariff Guidance. + +  + +21 April 2022: Minor changes have been made to the Technical Details Specification documents for each of the contract monitoring standards (DCB2050 Aggregate Contract Monitoring (ACM), DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM), DCB3002 Devices Patient Level Contract Monitoring (DePLCM) and DCB3003 Patient Level Contract Monitoring (PLCM)). These updates relate to the addition of a new code (code 12) in the Commissioned Service Category Code reference table of each document, to accommodate the forthcoming introduction of Integrated Care Boards (ICBs), following approval of the legislation. + +There have also been several new ‘High Level Codes’ added to the Taxonomy reference table in the DCB3002 DePLCM Technical Details Specification. + +  + +2 March 2022: A minor change has been made to the Technical Details Specification documents for both DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM) and DCB3002 Devices Patient Level Contract Monitoring (DePLCM). This update relates to the the 'Point of Delivery Code' tab in each document.  + +  + +2 February 2022: A minor change has been made to the Technical Details Specification for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy list to reflect the 2021-22 list (v16.1) of drugs not reimbursed through national prices and directly commissioned by NHS England. + +  + +16 November 2021: Copies of the User Guidance for each of the four standards, originally published on the NHS England and NHS Improvement website, have been added to the 'Supporting documents' sections above.  + +  + +8 July 2021: A minor change has been made to the Technical Details Specification for DCB2212 Drugs Patient Level Contract Monitoring (DrPLCM). This is an update to the drug taxonomy list to finally reflect the 2021-22 list (v16) of high cost drugs that are outside the National Tariff. + +  + +30 June 2021: A minor change has been made to the Technical Details Specification for DCB3002 Devices Patient Level Contract Monitoring (DePLCM), in relation to the taxonomy supporting reference table within the workbook.   + +  + +28 April 2021: Links to the NHS Data Model and Dictionary have been updated in the specification and technical specification documents above, following a recent change in platform. + +Last edited: 11 October 2022 5:56 pm \ No newline at end of file diff --git a/baselineTexts/patient-level-information-and-costing-systems-ambulance-data-set.txt b/baselineTexts/patient-level-information-and-costing-systems-ambulance-data-set.txt new file mode 100644 index 0000000..1063ce7 --- /dev/null +++ b/baselineTexts/patient-level-information-and-costing-systems-ambulance-data-set.txt @@ -0,0 +1,154 @@ +Patient-Level Information and Costing Systems + +Two information standards for patient-level costing, to provide a consistent approach to reporting cost information at patient level. + +Page contents +Top of page +About these information standards +Current releases +Previous releases +Updates +About these information standards + +These information standards support the implementation of NHS England and NHS Improvement's Patient Costing Transformation programme which is intended to deliver: + +better benchmarking of costs and patient pathways, enabling a reduction in unwarranted variation +better understanding of patient pathways, supporting the introduction of more effective care models +an improvement in accuracy of the national tariff and local prices, helping to strengthen efficiency incentives. + +The information standards mandate providers of acute, ambulance, mental health, Improving Access to Psychological Therapies (IAPT) and community services within England to submit patient-level activity and financial data to NHS Digital, acting on behalf of NHS England and NHS Improvement. + +For the 2021-2022 financial year, 2 standards have been approved: + +DAPB4001 Ambulance +DAPB4000 Integrated +covering acute, mental health, Improving Access to Psychological Therapies (IAPT) and community services. + +These information standards are published under section 250 of the Health and Social Care Act 2012.  An Information Standards Notice for each standard (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standards. + +In the event of issues or questions about any of these standards, please contact the developers at NHS England and NHS Improvement: costing@england.nhs.uk + +Current releases +DAPB4001 Ambulance +Release date 28 June 2022 +Release number Amd 21/2022 +Key documents +Specification (Amd 21/2022) +Change Specification (Amd 21/2022) +Implementation Guidance (Amd 21/2022) +Information Standards Notice (Amd 21/2022) + +  + + +Further information + +Approved Costing Guidance (ACG) on the NHS England and NHS Improvement website. + +Guidance on the PLICS data collection on the NHS Digital website.  + +  + +DAPB4000 Integrated +Release date 28 June 2022  +Release number Amd 20/2022 +Key documents +Specification (Amd 20/2022) +Change Specification (Amd 20/2022) +Implementation Guidance (Amd 20/2022) +Information Standards Notice (Amd 20/2022) + +  + + +Further information + +Approved Costing Guidance (ACG) on the NHS England and NHS Improvement website. + +Guidance on the PLICS data collection on the NHS Digital website.  + +Previous releases +DAPB4001 Ambulance +Release date 13 August 2021 +Release number Amd 17/2021 +Key documents +Information Standards Notice (superseded) (Amd 17/2021) +Information Standards Notice Version 1.1 (Amd 17/2021) +Change Specification (Amd 17/2021) +Specification (Amd 17/2021) +Implementation Guidance (Amd 17/2021) + +Supporting documents +NHS Data Model and Dictionary Change Request 1817 (covers both Ambulance and Integrated) +NHS Data Model and Dictionary Change Request 1817 (Full) (covers both Ambulance and Integrated) + +  + +DCB2123-02 Ambulance +Release date 16 December 2020 +Release number Amd 38/2020 +Key documents +Standard Specification (Amd 38/2020) +Implementation Guidance (Amd 38/2020) +Information Standards Notice (Amd 38/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1774 (Basic CR) (Amd 38/2020) +NHS Data Model and Dictionary Change Request 1774 (Data Set CR) (Amd 38/2020) + +  + +DAPB4000 Integrated +Release date 13 August 2021 +Release number Amd 15/2021 +Key documents +Information Standards Notice (superseded) (Amd 15/2021) +Information Standards Notice Version 1.1 (Amd 15/2021) +Specification (Amd 15/2021) +Implementation Guidance (Amd 15/2021) + +Supporting documents + NHS Data Model and Dictionary Change Request 1817 (covers both Ambulance and Integrated) +NHS Data Model and Dictionary Change Request 1817 (Full) (covers both Ambulance and Integrated) +  +DCB2123 Acute +Release date 26/06/2020 +Release number Amd 90/2019 +Key documents +Information Standards Notice (Amd 90/2019) +Change Specification (Amd 90/2019) +Standard Specification (Amd 90/2019) +Implementation Guidance (Amd 90/2019) + +Supporting documents +NHS Data Model and Dictionary Change Request 1759 (Basic CR) (Amd 90/2019) +NHS Data Model and Dictionary Change Request 1759 (Data Set CR) (Amd 90/2019) +  +DCB2123-03 Mental Health  +Release date  16 December 2020 +Release number Amd 39/2020 +Key documents  +Standard Specification (Amd 39/2020) +Implementation Guidance (Amd 39/2020) +Information Standards Notice (Amd 39/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1797 (Basic CR) (Amd 39/2020) +NHS Data Model and Dictionary Change Request 1797 (Data Set CR) (Amd 39/2020) +  +DCB2123-04 Improving Access to Psychological Therapies (IAPT) +Release date 16 December 2020 +Release number Amd 40/2020 +Key documents +Standard Specification (Amd 40/2020) +Implementation Guidance (Amd 40/2020) +Information Standards Notice (Amd 40/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1778 (Basic CR) (Amd 40/2020) +NHS Data Model and Dictionary Change Request 1778 (Data Set CR) (Amd 40/2020) +Updates + +7 October 2021: Version 1.1 of the Information Standards Notices for both Ambulance (Amd 17/2021) and Integrated (Amd 15/2021) have been issued to note a change to the submission window which will now close on 26 November 2021 (extended from 29 October 2021). + +Last edited: 28 June 2022 1:39 pm \ No newline at end of file diff --git a/baselineTexts/patient-level-information-and-costing-systems-integrated-data-set.txt b/baselineTexts/patient-level-information-and-costing-systems-integrated-data-set.txt new file mode 100644 index 0000000..1063ce7 --- /dev/null +++ b/baselineTexts/patient-level-information-and-costing-systems-integrated-data-set.txt @@ -0,0 +1,154 @@ +Patient-Level Information and Costing Systems + +Two information standards for patient-level costing, to provide a consistent approach to reporting cost information at patient level. + +Page contents +Top of page +About these information standards +Current releases +Previous releases +Updates +About these information standards + +These information standards support the implementation of NHS England and NHS Improvement's Patient Costing Transformation programme which is intended to deliver: + +better benchmarking of costs and patient pathways, enabling a reduction in unwarranted variation +better understanding of patient pathways, supporting the introduction of more effective care models +an improvement in accuracy of the national tariff and local prices, helping to strengthen efficiency incentives. + +The information standards mandate providers of acute, ambulance, mental health, Improving Access to Psychological Therapies (IAPT) and community services within England to submit patient-level activity and financial data to NHS Digital, acting on behalf of NHS England and NHS Improvement. + +For the 2021-2022 financial year, 2 standards have been approved: + +DAPB4001 Ambulance +DAPB4000 Integrated +covering acute, mental health, Improving Access to Psychological Therapies (IAPT) and community services. + +These information standards are published under section 250 of the Health and Social Care Act 2012.  An Information Standards Notice for each standard (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standards. + +In the event of issues or questions about any of these standards, please contact the developers at NHS England and NHS Improvement: costing@england.nhs.uk + +Current releases +DAPB4001 Ambulance +Release date 28 June 2022 +Release number Amd 21/2022 +Key documents +Specification (Amd 21/2022) +Change Specification (Amd 21/2022) +Implementation Guidance (Amd 21/2022) +Information Standards Notice (Amd 21/2022) + +  + + +Further information + +Approved Costing Guidance (ACG) on the NHS England and NHS Improvement website. + +Guidance on the PLICS data collection on the NHS Digital website.  + +  + +DAPB4000 Integrated +Release date 28 June 2022  +Release number Amd 20/2022 +Key documents +Specification (Amd 20/2022) +Change Specification (Amd 20/2022) +Implementation Guidance (Amd 20/2022) +Information Standards Notice (Amd 20/2022) + +  + + +Further information + +Approved Costing Guidance (ACG) on the NHS England and NHS Improvement website. + +Guidance on the PLICS data collection on the NHS Digital website.  + +Previous releases +DAPB4001 Ambulance +Release date 13 August 2021 +Release number Amd 17/2021 +Key documents +Information Standards Notice (superseded) (Amd 17/2021) +Information Standards Notice Version 1.1 (Amd 17/2021) +Change Specification (Amd 17/2021) +Specification (Amd 17/2021) +Implementation Guidance (Amd 17/2021) + +Supporting documents +NHS Data Model and Dictionary Change Request 1817 (covers both Ambulance and Integrated) +NHS Data Model and Dictionary Change Request 1817 (Full) (covers both Ambulance and Integrated) + +  + +DCB2123-02 Ambulance +Release date 16 December 2020 +Release number Amd 38/2020 +Key documents +Standard Specification (Amd 38/2020) +Implementation Guidance (Amd 38/2020) +Information Standards Notice (Amd 38/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1774 (Basic CR) (Amd 38/2020) +NHS Data Model and Dictionary Change Request 1774 (Data Set CR) (Amd 38/2020) + +  + +DAPB4000 Integrated +Release date 13 August 2021 +Release number Amd 15/2021 +Key documents +Information Standards Notice (superseded) (Amd 15/2021) +Information Standards Notice Version 1.1 (Amd 15/2021) +Specification (Amd 15/2021) +Implementation Guidance (Amd 15/2021) + +Supporting documents + NHS Data Model and Dictionary Change Request 1817 (covers both Ambulance and Integrated) +NHS Data Model and Dictionary Change Request 1817 (Full) (covers both Ambulance and Integrated) +  +DCB2123 Acute +Release date 26/06/2020 +Release number Amd 90/2019 +Key documents +Information Standards Notice (Amd 90/2019) +Change Specification (Amd 90/2019) +Standard Specification (Amd 90/2019) +Implementation Guidance (Amd 90/2019) + +Supporting documents +NHS Data Model and Dictionary Change Request 1759 (Basic CR) (Amd 90/2019) +NHS Data Model and Dictionary Change Request 1759 (Data Set CR) (Amd 90/2019) +  +DCB2123-03 Mental Health  +Release date  16 December 2020 +Release number Amd 39/2020 +Key documents  +Standard Specification (Amd 39/2020) +Implementation Guidance (Amd 39/2020) +Information Standards Notice (Amd 39/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1797 (Basic CR) (Amd 39/2020) +NHS Data Model and Dictionary Change Request 1797 (Data Set CR) (Amd 39/2020) +  +DCB2123-04 Improving Access to Psychological Therapies (IAPT) +Release date 16 December 2020 +Release number Amd 40/2020 +Key documents +Standard Specification (Amd 40/2020) +Implementation Guidance (Amd 40/2020) +Information Standards Notice (Amd 40/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1778 (Basic CR) (Amd 40/2020) +NHS Data Model and Dictionary Change Request 1778 (Data Set CR) (Amd 40/2020) +Updates + +7 October 2021: Version 1.1 of the Information Standards Notices for both Ambulance (Amd 17/2021) and Integrated (Amd 15/2021) have been issued to note a change to the submission window which will now close on 26 November 2021 (extended from 29 October 2021). + +Last edited: 28 June 2022 1:39 pm \ No newline at end of file diff --git a/baselineTexts/personal-demographics-service-notifications-fhir-api.txt b/baselineTexts/personal-demographics-service-notifications-fhir-api.txt index 3b3c97a..a29d597 100644 --- a/baselineTexts/personal-demographics-service-notifications-fhir-api.txt +++ b/baselineTexts/personal-demographics-service-notifications-fhir-api.txt @@ -1,13 +1,13 @@ -Personal Demographics Service Notifications - FHIR API +Personal Demographics Service Notifications - FHIR -Receive notifications about changes to a patient's demographic details, including birth, death, change of address and change of GP. +Receive notifications about changes to a patient's demographic details, including record change, birth, death, change of address and change of GP. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status and roadmap +Status and roadmap Service level Technology Network access @@ -16,21 +16,45 @@ Environments and testing Onboarding Interactions Overview +Sending System -Use this API to receive notifications about changes to a patient's demographic details, including: +NEMS +publish event +MESH + +send event to all +subscribing systems + +Subscribed +System B + +Subscribed +System A + +Subscribed +System C + +manage subscriptions + +  + +Use this integration to receive notifications about changes to a patient's demographic details, including: birth notifications - although another option is PDS HL7 V3 API death notifications change of address change of GP +any record change (beta) - to notify subscribers to synchronise their local PDS patient database + +We share information about these events with healthcare workers in other organisations such as GPs, Emergency Departments and Local Authorities. -We share information about these events, using a publication-subscription model, with healthcare workers in other organisations such as GPs, Emergency Departments and Local Authorities. To receive these messages you need to subscribe to them via National Events Management Service (NEMS) and collect them via MESH. +This integration uses a publish-subscribe model - the sending system publishes events to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via Message Exchange for Social Care and Health (MESH). For example, when we update Personal Demographics Service (PDS) with a birth, PDS sends a birth notification event containing information about the birth to NEMS. NEMS then sends the event to all healthcare workers who have subscribed to receive birth notifications. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. To do this, contact us. @@ -38,48 +62,50 @@ For details of the legal basis for sharing NEMS events, see the NEMS controller Related APIs -The following APIs are also related to this API: +The following APIs are also related to this integration: -National Events Management Service (NEMS) API - use this API to publish and subscribe to patient-centric event messages +National Events Management Service (NEMS) - use this integration to publish and subscribe to patient-centric event messages Message Exchange for Social Care and Health (MESH) API - use this API to collect events that you have subscribed to Personal Demographics Service - FHIR API - use this newer API to search for patients, retrieve patients by NHS number and update patients Personal Demographics Service - HL7 V3 API - use this if you want to use functions that are not yet available on the FHIR API, such as creating a new record for a birth, receiving birth notifications, or creating a record for a new patient (except when registering a new patient at a GP Practice, use NHAIS). -API status and roadmap +Status and roadmap + +This integration is in production. -This API is stable. +The PDS Record Change event is in production, beta. To see our roadmap, or to suggest, comment or vote on features for this API, see our interactive product backlog. Service level -This API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses NEMS which is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays. + +It also uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding Bank Holidays. For more details, see service levels. Technology -This API is a FHIR API. - -It uses a publish-subscribe model. +This integration uses a publish-subscribe model. -Use our National Events Management Service (NEMS) API to subscribe to events. +Use National Events Management Service (NEMS) to subscribe to events. Use our MESH API to collect event messages that you have subscribed to. -The message payload is based on the HL7 FHIR STU3 Messaging Implementation. +NEMS is a FHIR API. Specifically it uses FHIR STU3. Network access -This API is available on the internet and on the Health and Social Care Network (HSCN). +This integration uses NEMS and MESH, both of which are available on the internet and on the Health and Social Care Network (HSCN). For more details see Network access for APIs. Security and authorisation -This API uses NEMS and MESH APIs which are application-restricted, meaning we authenticate the calling application but not the end user. +This integration uses the NEMS and MESH APIs, both of which are application-restricted, meaning we authenticate the calling application but not the end user. You can use this pattern as follows: @@ -87,13 +113,13 @@ unattended (end user not present), for example as part of a back end process to attended (end user present) - in which case, you must ensure the end user is authenticated and suitably authorised locally by the calling application -In particular, this API uses TLS-MA authentication. +In particular, NEMS and MESH both uses TLS-MA authentication. -It also implements authorisation controls which restrict the event types that the connecting application can subscribe to or publish. +NEMS also implements authorisation controls which restrict the event types that the connecting application can subscribe to or publish. Environments and testing -This API uses NEMS, which is available in Opentest for early development and testing. +This integration uses NEMS, which is available in Opentest for early development and testing. NEMS is also available for testing purposes in: @@ -133,21 +159,22 @@ For more details, see the NEMS onboarding guide on getting access to Opentest an Onboarding -You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. +You need to get your software approved by us before it can go live with this integration. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. -To outline your use case and start the onboarding process for this API, contact us. +To outline your use case and start the onboarding process for this integration, contact us. Interactions -For a full list of interactions for this API, see Publish an Event Message and Subscriptions Overview. +For a full list of interactions, see Publish an Event Message and Subscriptions Overview. -This API supports the following event types: +This integration supports the following event types: PDS Birth Notification PDS Change of Address PDS Change of GP PDS Death Notification +PDS Record Change (beta) For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 4:32 pm \ No newline at end of file +Last edited: 14 October 2022 7:35 am \ No newline at end of file diff --git a/baselineTexts/personal-demographics-service-smsp-api-standards.txt b/baselineTexts/personal-demographics-service-smsp-api-standards.txt new file mode 100644 index 0000000..820bdcd --- /dev/null +++ b/baselineTexts/personal-demographics-service-smsp-api-standards.txt @@ -0,0 +1,150 @@ +Personal Demographics Service - SMSP API standards + +Become a Spine Mini Service Provider giving access to patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number, using our Spine Mini Service Provider (SMSP) API standards. + +Page contents +Top of page +Overview +Who can use this API +Related APIs +API status +Technology +Network access +Security and authorisation +Environments and testing +Onboarding +Interactions +Downloads + +This page describes our PDS SMSP API standards. They are under review and we're considering deprecating them. If you have any concerns, contact us. + +Note: we have deprecated our own NHS Digital operated PDS SMSP API service, see Personal Demographics Service - SMSP API. + +Overview + +Become a Spine Mini Service Provider giving access to the Personal Demographics Service (PDS), using our Spine Mini Service Provider (SMSP) API standards. PDS is the national electronic database of NHS patient details such as name, address, date of birth, related people, registered GP and NHS number. + +Your commercially available Spine Mini Service Providers (SMSP) product will give access to PDS for your SMSP clients. We will list your SMSP provider service along with other conforming software products in our Conformance Catalogue. + +Before you begin any development work using these API standards, contact us to discuss your best options. + +Your SMSP clients can: + +verify a patient's NHS number +retrieve a patient's details +search for patient details + +Your SMSP clients cannot: + +update patient details +create a new record for a birth +receive birth notifications +create a new record for a new patient +register a new patient at a GP Practice - use National Health Application and Infrastructure Services (NHAIS) instead + +These API standards: + +do not require the SMSP client end user to be strongly authenticated with a smartcard +only return a result from a search if there is a single, unique match - it does not return multiple matches +Who can use this API + +These API standards can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.  To do this, make a PDS access request.  + +You must do this before you can go live (see ‘Onboarding’ below).  + +Related APIs + +The following APIs also give access to the Personal Demographics Service: + +Personal Demographics Service - FHIR API - use this newer API to search for patients, retrieve patients by NHS number and update patients +Personal Demographics Service - HL7 V3 API - use this if you want to use functions that are not yet available on the FHIR API, such as creating a new record for a birth, receiving birth notifications, or creating a record for a new patient (except when registering a new patient at a GP Practice, use NHAIS). For birth notifications, another option is PDS Notifications FHIR API +Personal Demographics Service - SMSP API - this API is now deprecated + +The following APIs are also related to these API standards: + +Organisation Data Service - FHIR API - use this to get full details for the organisations related to the patient, such as their registered GP or nominated pharmacy +Organisation Data Service - ORD API - use this to access a searchable national repository of NHS Organisation Reference Data using an ORD interface +API status + +These API standards are stable but under review. + +Technology + +These API standards are based on our Personal Demographics Service - HL7 V3 API but with a simplified read-only model. All interactions are synchronous. + +For more details, see HL7 V3. + +Network access + +You need a Health and Social Care Network (HSCN) connection to use these API standards. + +For more details, see Network access for APIs. + +Security and authorisation + +These API standards are application-restricted, meaning: + +the calling SMSP client application is authenticated - we do care who it is +the SMSP client end user is not authenticated - we do not verify who it is or whether they are present + +In particular, these API standards use TLS-MA authentication. + +In addition, we require SMSP client calling applications to: + +authenticate end users locally with a minimum of user ID and password +use role-based access control (RBAC) locally to control end user access to the patient data +keep an audit trail locally of all accesses to patient data by end users +Environments and testing + +You can test these API standards using our Path to Live environments. + +Onboarding + +You must get your software onboarded before it can go live. + +As part of onboarding, these API standards use the Target Operating Model (TOM) process, which is simpler than the traditional Common Assurance Process (CAP). + +Note that SMSP provider software assurance is required but we do not need to assure your SMSP clients. + +For more details, and to get a copy of the latest TOM forms to complete, contact the interoperability conformance team on itkconformance@nhs.net. + +Interactions + +For details of SMSP provider interactions, see the following downloads: + +SMSP Common Provider Requirements V1.1 - 23/09/2014 PDF +PDS SMSP Provider Requirements V1.1 - 23/09/2014 PDF + +For details of SMSP client interactions, to share with your clients, see the following downloads: + +SMSP Common Client Requirements - 23/09/2014 PDF +PDS SMSP Client Requirements V1.1 - 18/12/2014 PDF + +Both SMSP providers and SMSP clients need the same response codes: + +SMSP Response Codes - 24/07/2014 XLS +Downloads + +These are PDF and Microsoft Excel files. To request a different format, contact us. + +SMSP Common Provider Requirements V1.1 - 23/09/2014 PDF + +PDF 718 KB + +PDS SMSP Provider Requirements V1.1 - 23/09/2014 PDF + +PDF 761 KB + +SMSP Common Client Requirements - 23/09/2014 PDF + +PDF 663 KB + +PDS SMSP Client Requirements V1.1 - 18/12/2014 PDF + +PDF 714 KB + +SMSP Response Codes - 24/07/2014 XLS + +XLSX 17 KB + +Last edited: 13 October 2022 1:21 pm \ No newline at end of file diff --git a/baselineTexts/personalised-care-and-support-plan.txt b/baselineTexts/personalised-care-and-support-plan.txt index 1f5dece..63a0186 100644 --- a/baselineTexts/personalised-care-and-support-plan.txt +++ b/baselineTexts/personalised-care-and-support-plan.txt @@ -19,6 +19,7 @@ Latest version: V2.0 In 2021 an updated version of the standard was published to support adults who live with severe and enduring mental health conditions in the community. Co-produced with health and social care professionals, as well as people who use services, the standard is designed to help people stay well and live the best lives they can at home or in supported accommodation.  +V2.0 – View the standard (Excel) Personalised care and support plan standard V2.0 – View the standard (Excel) Supporting documents @@ -37,7 +38,6 @@ The original Digital care and support plan has been updated to V2.0 Personalised DCSP standard Version 1.1 Implementation guidance V1.0 - Digital care and support plan final report V1.0 Survey results and analysis Clinical safety case report V0.3 diff --git a/baselineTexts/radiotherapy-data-set.txt b/baselineTexts/radiotherapy-data-set.txt new file mode 100644 index 0000000..2463349 --- /dev/null +++ b/baselineTexts/radiotherapy-data-set.txt @@ -0,0 +1,67 @@ +DAPB0111: Radiotherapy Data Set + +Providers of NHS-funded radiotherapy services are required to submit a monthly return on their delivery of radiotherapy treatments. + +Page contents +Top of page +About this information standard +Current release +Previous releases +Updates +About this information standard + +The purpose of the Radiotherapy Data Set is to: + +collect consistent and comparable data across all NHS acute trust providers of radiotherapy services and all private facilities where delivery is funded by the NHS +provide nationally comparable data to inform the planning, provision and commissioning of radiotherapy services across the NHS. + +It has been a mandatory standard since April 2009 and collects information for every patient receiving treatment of: + +external beam radiotherapy (teletherapy) +brachytherapy +proton therapy +radioisotope therapy (including radioiodine) +molecular radiotherapy. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales. The other key documents (Change Request, Specification and Implementation Guide) provide further detail for those who have to implement the information standard. + +Current release +Release date 20 July 2021 +Release number Amd 84/2020 +Release title Version 6.0 +Stage Implementation (April 2022 start date) +Key documents +Information Standards Notice (Amd 84/2020) +Specification (Amd 84/2020) +Change Request (Amd 84/2020) +Implementation Guide (Amd 84/2020) + +Supporting documents +NHS Data Model and Dictionary Change Request 1736 (Basic CR) (Amd 84/2020) (2022) +NHS Data Model and Dictionary Change Request 1736 (Data Set CR) (Amd 84/2020) (2022) + +Further information +National Cancer Registration and Analysis Service (NCRAS) Radiotherapy Data Set +Previous releases +Release date 19 November 2015 +Release number Amd 13/2015 +Release title Version 5.0 +Stage Maintenance (until version 6.0 comes into force) +Key documents +Requirements Specification (Amd 13/2015) [Archive Content] +Change Specification (Amd 13/2015) +Implementation Guidance (Amd 13/2015) +Information Standards Notice (Amd 13/2015) + +Supporting documents +NHS Data Model and Dictionary Change Request 1544 (Basic CR) (Amd 13/2015) +NHS Data Model and Dictionary Change Request 1544 (Data Set CR) (Amd 13/2015) + +Previous releases The initial and subsequent releases approved by the Information Standards Board (ISB) can be found on the ISB archive site. +Updates + +21 April 2022: The NHS Data Model and Dictionary Change Requests (DDCRs) for Version 6.0 (Amd 84/2020) have been updated in the table above.   + +At the time of publication of Version 6.0, 20 July 2021, the associated DDCRs noted that the publication of SNOMED CT Refset Metadata for use with the data item RADIOPHARMACEUTICAL PROCEDURE (SNOMED CT) was yet to be confirmed (TBC). The refset metadata is now available on the National Disease Registration Service website, as part of the National Radiotherapy Dataset (RTDS) user guide, and the Data Dictionary has been updated to reflect this. + +Last edited: 8 June 2022 1:32 pm \ No newline at end of file diff --git a/baselineTexts/secure-email.txt b/baselineTexts/secure-email.txt index 36590cb..15bcb0c 100644 --- a/baselineTexts/secure-email.txt +++ b/baselineTexts/secure-email.txt @@ -59,10 +59,10 @@ Release date Release number Amd 3/2016 Stage Retirement Key documents -Requirements Specification (Amd 3/2016) +Requirements Specification (Amd 3/2016) [Archive Content] Implementation Guidance (Amd 3/2016) -Change Specification (Amd 3/2016) -Information Standards Notice (Amd 3/2016) +Change Specification (Amd 3/2016) [Archive Content] +Information Standards Notice (Amd 3/2016) [Archive Content] Previous releases diff --git a/baselineTexts/sexual-and-reproductive-health-activity-dataset.txt b/baselineTexts/sexual-and-reproductive-health-activity-dataset.txt new file mode 100644 index 0000000..1a4eb9b --- /dev/null +++ b/baselineTexts/sexual-and-reproductive-health-activity-dataset.txt @@ -0,0 +1,41 @@ +SCCI1518: Sexual and Reproductive Health Activity Dataset + +The Sexual and Reproductive Health Activity Dataset (SRHAD) mandates the collection of contraceptive activity data from sexual and reproductive health services. + +Page contents +Top of page +About this information standard +Current release +About this information standard + +Initially published in March 2010, this latest release introduces: + +minor amendments to data items to align with the NHS Data Model and Dictionary +confirmation of annual submission +clarification of coverage in general practice settings. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Release date 29 June 2017 +Release number Amd 92/2015 +Release title 2017 update +Stage Implementation +Key documents +Information Standards Notice (Amd 92/2015) +Requirements Specification (Amd 92/2015) +Implementation Guidance (Amd 92/2015) +Change Specification (Amd 92/2015) + + + +Supportingdocuments + + +NHS Data Model and Dictionary Change Request 1555 (Amd 92/2015) +NHS Data Model and Dictionary Change Request 1555 (Full) (Amd 92/2015) + +More information Go to the SRHAD pages of the NHS Digital website for more detailed guidance +Archive Go to the ISB website for previous releases of this standard + +Last edited: 9 October 2019 1:06 pm \ No newline at end of file diff --git a/baselineTexts/shared-decision-making.txt b/baselineTexts/shared-decision-making.txt new file mode 100644 index 0000000..c67f0b2 --- /dev/null +++ b/baselineTexts/shared-decision-making.txt @@ -0,0 +1,181 @@ +Shared Decision Making Standard + +Shared decision making is a collaborative process where clinicians and individuals consider treatment options based on evidence about their potential benefits and harms, to enable the person to decide the best course for themselves. The conversation and decision made should be informed by what matters to the person, their goals, values, hopes, ideas, concerns and expectations. + +When people are listened to, given the information they need and the time and support to make informed decisions about their care and treatment, they have the potential for better outcomes and experiences of care. + +On this page +About this standard +The patient’s journey +Summary view of the standard +Current release and supporting documentation +About this standard + +The PRSB information standard on shared decision making provides a framework for clinicians to record the decision-making process between themselves and their patients. The standard also allows the shared decision information to be shared between professionals and their different record systems. The standard has been developed based on the GMC guidance on shared decision-making and consent and the NICE guidelines.  + +What is included? +The standard was developed with UK wide consultation and engagement to meet the needs of all four UK nations. +The standard is intended for all areas of healthcare except for the noted exclusions +The standard covers all ages including children + + +The following 8 different scenarios were used to help develop and test the standard; + +Elective surgery +Multiple long-term conditions   +Mental Health  +Genetic conditions +Polypharmacy   +Orthopaedics  +Gynaecology +Children and dentistry +What is not in scope +Maternity – The standard may work for maternity, but it is believed that this complex area justifies specific additional work and potentially an extended standard. + + +Social Care – The Shared Decision Making Standard is defined for clinical uses and the consultation was targeted at healthcare professionals not social care professionals. However the standard’s principles may work in social care and in the future the standard could potentially be adapted for use in social care. +The patient's journey + +Here we can see an example of a shared decision making journey from starting a shared decision with a patient and their clinician, through to planning and discussion and then making a final agreement to document in a patient’s care record.  + +Starting a shared decision +The first meeting + + +Joe meets or talks on the phone with his clinician (this is his doctor or nurse or other health professional) who has diagnosed the problem. + + +The clinician explains the diagnosis to Joe and says there are choices for his treatment or support. + + +The clinician gives Joe some information on the choices available to consider before further meetings. + + +The clinician asks if Joe would want someone to be at the next meeting. +Shared decision discussions +Talking through the choices + + +Joe meets the clinician to discuss the best treatment or support for him. This is the shared decision making discussion. + + +Joe consents to the meeting being recorded so it can be referred to later. + + +The clinician checks with Joe to agree that this is the expectation for the meeting so that he understands his diagnosis. + + +The clinician and Joe explore what’s important to Joe, his concerns, expectations, needs and goals. + + +The clinician explains each of the options along with their risks and benefits for Joe. + + +They discuss and reach a shared decision on the best option for Joe. Joe decides he needs more time to consider. The doctor sends Joe a letter with the details of the discussion. +Reaching a final decision +Agreeing what is important + + +They recap and discuss as needed, considering what’s important to Joe, the options and their risks and benefits. + + +They record the option agreed and a review date. If needed they can record any issues Joe had with the decision or any comments made by the clinician. + + +If required, Joe provides consent for the chosen treatment or support. Details about the consent form are recorded. + + +The clinician notes the actions for Joe and themselves (such as to start the chosen treatment or support option). +Summary view of the standard + +The standard sets out the information that should be recorded for a shared decision making discussion between a clinician and patient, and then shared afterwards with the patient and other professionals who care for them.  + +Here is an excerpt from a summary view of the standard that shows main sections and elements.  It gives a description of the information to be captured and also tells the clinician what information is Mandatory (M – must be recorded), Required (R – should be recorded if the information exists), and what is Optional (O – local decision if its recorded) in the Conformance column.  + +Section and element name + +Conformance + +Description + + +Problem list + +M + +A summary of the problems that require investigation or treatment. + + +Problem + +M + +The problem that the shared decision is addressing + + +Shared decision point + +M + +This is a shared decision point record entry. There may be 0 to many record entries under a section. Each record entry is made up of a number of elements or data items. + + +Shared decision status + +M + +The current status of the decision (In progress, Valid, Cancelled). + + +Pre-discussion information shared + +R + +A record of the actions taken to prepare the patient to make a shared decision before the encounter where a shared decision was made. This should include a summary of any resources the person was offered to prepare them for the decision making process. + +This is an excerpt taken from a high-level summary view of the standard. Open the summary view: Shared Decision Making Standard summary view + +The full standard can be found under the Current Release section below. + +We have created some examples to help make it clearer what information is recorded in several different SDM scenarios, and how this works across multiple appointments.  These examples are based on role plays with practising clinicians and either patients or actors. In some cases they are shown with two views, one for clinicians and people and another for system suppliers using the full information model.    + +Current release +Release date: 8 June 2022 +Standard Version: V0.6 Shared Decision Making Information Standard + +Supporting documents +General implementation guidance +(Detailed guidance, specific to the sections and elements of the standard, are included within the information model) +Business rules +Final report +Survey report +Safety case report - draft +Hazard log - draft +Phase 1 report V1.0 +– Appendix A – Evidence review report +– Appendix C – Original use case scenarios +– Appendix D – Structured role play materials +– Appendix E – Webinar materials and participants +  +Examples + +Example for Elective surgery (Abdominal Aortic Aneurysm) +Clinician/Person view +System Supplier view + +Example for Primary Care +Clinician/Person view + +Example for Pharmacy medications review +Medicine Review by Pharmacy St + +Further resources +Shared decision making – NICE guidelines +Decision making and consent – GMC +Working group feedback video +IHRIM record correction guidance +Despite vigilance when filing information in records, mistakes can occur. The Institute of Health Records and Information Management has guidance to support professionals in making corrections following errors. +  +Endorsement +Endorsement is in progress for the draft standard and details will be published here when this work is complete.  +  \ No newline at end of file diff --git a/baselineTexts/snomed-ct.txt b/baselineTexts/snomed-ct.txt index 84d0371..f429250 100644 --- a/baselineTexts/snomed-ct.txt +++ b/baselineTexts/snomed-ct.txt @@ -53,7 +53,7 @@ Release date 02/11/2016 (07/05/2020) Release number Amd 35/2016 Stage Implementation Key documents -Requirements Specification (Amd 35/2016) Version 2.0 +Requirements Specification (Amd 35/2016) Version 2.0 [Archive Content] Change Specification (Amd 35/2016) Version 2.0 Implementation Guidance (Amd 35/2016) Version 2.0 Information Standards Notice (Amd 35/2016) @@ -74,6 +74,6 @@ Advance Notification An Advance Notification for SCCI0034 Amd 35/2016 was published on 12 May 2016. This is now out-of-date, following the publication of the Information Standards Notice, and is included here for historic reference only: - Advance Notification (Amd 35/2016) + Advance Notification (Amd 35/2016) [Archive Content] Last edited: 7 May 2020 10:11 am \ No newline at end of file diff --git a/baselineTexts/summary-care-record-smsp-api-standards.txt b/baselineTexts/summary-care-record-smsp-api-standards.txt index d46921b..0794e5b 100644 --- a/baselineTexts/summary-care-record-smsp-api-standards.txt +++ b/baselineTexts/summary-care-record-smsp-api-standards.txt @@ -51,9 +51,9 @@ Related APIs The following APIs are related to these API standards: -Summary Care Record - FHIR API - use this API to access a patient's SCR using our FHIR API. -Summary Care Record - HL7 V3 API - use this to access a patient's SCR using our HL7 V3 API. -Legitimate Relationship Service - HL7 V3 API - use this API to access a patient's Legitimate Relationships, using our HL7 V3 API. +Summary Care Record - FHIR API - use this API to access a patient's SCR using our FHIR API +Summary Care Record - HL7 V3 API - use this to access a patient's SCR using our HL7 V3 API +Legitimate Relationship Service - HL7 V3 API - this API is now deprecated API status These API standards are stable. @@ -69,8 +69,6 @@ PSIS Document Data Request For more details, see HL7 V3. -  - Network access You need a Health and Social Care Network (HSCN) connection to use these API standards. @@ -170,4 +168,4 @@ SMSP Response Codes - 24/07/2014 XLS XLSX 17 KB -Last edited: 18 November 2021 4:56 pm \ No newline at end of file +Last edited: 14 October 2022 9:13 am \ No newline at end of file diff --git a/baselineTexts/surgical-devices-and-implants-core-data-set.txt b/baselineTexts/surgical-devices-and-implants-core-data-set.txt new file mode 100644 index 0000000..e593114 --- /dev/null +++ b/baselineTexts/surgical-devices-and-implants-core-data-set.txt @@ -0,0 +1,36 @@ +DAPB3103: Surgical Devices and Implants Core Data Set + +The Surgical Devices and Implants Core Data Set enables the national reporting of activity relating to surgical devices and implants in health care settings. + +Page contents +Top of page +About this information standard +Current release +Updates +About this information standard + +The Surgical Devices and Implants Core Data Set (SDICDS) is a patient level, secondary uses data set which is intended to capture generic data to link patients to specific implants or devices inserted by specific clinicians at a specific location in a robust, comprehensive, nationally consistent and comparable patient-based manner. + +The standard has been commissioned by the Department of Health and Social Care to support the Secretary of State’s strategic requirements to ensure patient safety in the use of surgical devices and implants and the equivalent requirements raised by the Independent Medicines and Medical Devices Safety Review: First Do No Harm (Cumberlege Report). + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +  +Release date 03/02/2022 +Release number Amd 100/2021 +Release title Version 1.0 +Stage Implementation (until 1 July 2022) +Key documents +Information Standards Notice (Amd 100/2021) +Requirements Specification (Amd 100/2021) +Implementation Guidance (Amd 100/2021) +Technical Output Specification v 1.1 (April 2022) (Amd 100/2021) +Corrigendum (April 2022) (Amd 100/2021) + +Further information NHS Digital National Perioperative Data Standard Programme +Updates + +11 April 2022: Publication of Corrigendum in respect of Version 1.0, supported by changes to the Technical Output Specification (uplifted to document version 1.1). See Corrigendum above for full details. + +Last edited: 11 May 2022 12:20 pm \ No newline at end of file diff --git a/baselineTexts/surveillance-of-healthcare-associated-infections.txt b/baselineTexts/surveillance-of-healthcare-associated-infections.txt new file mode 100644 index 0000000..c92c3c2 --- /dev/null +++ b/baselineTexts/surveillance-of-healthcare-associated-infections.txt @@ -0,0 +1,48 @@ +DCB0134: Surveillance of Healthcare Associated Infections (HCAI) + +This information standard supports the national surveillance programme managed by Public Health England in respect of Healthcare Associated Infections (HCAI). + +Page contents +Top of page +About this information standard +Current release +Previous release +About this information standard + +This information standard supports the national surveillance programme managed by Public Health England in respect of Healthcare Associated Infections (HCAI): + +Meticillin resistant Staphylococcus aureus(MRSA) +Meticillin susceptible Staphylococcus aureus(MSSA) +Clostridium difficile infection (CDI) +Escherichia coli (E. coli) + +The data are used to: + +identify trends in the prevalence of HCAI +monitor progress on infection control +provide epidemiological evidence to inform action to reduce HCAI +provide information to the public to support patient choice. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other documents provide further detail for those who have to implement the information standard. + +Current release +Release date 20 December  2017 +Release number Amd 18/2017 +Release title Version 3.0 +Stage Implementation +Key documents +Specification (Amd 18/2017) +Change Request (Amd 18/2017) +Implementation Guidance (Amd 18/2017) +Information Standards Notice (Amd 18/2017) + +Supporting documents +PHE Data Dictionary July 2017 (Amd 18/2017) [Archive Content] +HCAI Operating Procedure Codes supplement (Amd 18/2017) + +Further information Further guidance is published by Public Health England +Previous release + +Previous releases of this information standard can be found on the ISB website (external link). + +Last edited: 1 November 2018 2:52 pm \ No newline at end of file diff --git a/baselineTexts/systemic-anti-cancer-therapy-data-set.txt b/baselineTexts/systemic-anti-cancer-therapy-data-set.txt new file mode 100644 index 0000000..ab0b14f --- /dev/null +++ b/baselineTexts/systemic-anti-cancer-therapy-data-set.txt @@ -0,0 +1,51 @@ +DCB1533: Systemic Anti-Cancer Therapy Data Set + +The Systemic Anti-Cancer Therapy (SACT) data set captures activity data relating to the treatment of cancer with medicines. + +Page contents +Top of page +About this information standard +Current release +Previous release +About this information standard + +Since May 2014, all NHS trusts in England which deliver systemic anti-cancer therapy (SACT) are required to provide comprehensive monthly usage data to Public Health England. These data include information on all anti-cancer drugs given to adult and paediatric patients with solid or haematological malignancies. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the other listed documents provide further detail for those who have to implement the information standard. + +Current release +Release date 06/12/2018 +Release number Amd 80/2018 +Release title Version 3.0 +Stage Implementation  +Key documents  +Information Standards Notice (Amd 80/2018) +Specification (Amd 80/2018) +Change request (Amd 80/2018) +Implementation guide (Amd 80/2018) + +Supporting documents  +NHS Data Model and Dictionary Change Request 1661 (basic)  +NHS data Model and Dictionary Change Request 1661 (data set)  + +Further information  + +More information can be found on the Public Health England Systemic Anti-Cancer Therapy (SACT) web pages. + +Previous release +Release date 06/11/2013 +Release number Amd 24/2013 +Release title  Version 2.0 updates +Stage  Maintenance +Key documents  +Information Standards Notice (Amd 24/2013) +Specification (Amd 24/2013) +Change request (Amd 24/2013) +Guidance (Amd 24/2013) +SACT Dataset v2.0 (Amd 24/2013) + +Supporting documents  NHS Data Model and Dictionary Change Request 1370 + +  + +Last edited: 13 December 2018 11:30 am \ No newline at end of file diff --git a/baselineTexts/transfer-of-care-acute-inpatient-discharge-standard.txt b/baselineTexts/transfer-of-care-acute-inpatient-discharge-standard.txt new file mode 100644 index 0000000..cd8997e --- /dev/null +++ b/baselineTexts/transfer-of-care-acute-inpatient-discharge-standard.txt @@ -0,0 +1,46 @@ +DAPB4042: Transfer of Care – Acute Inpatient Discharge Standard + +An information standard to establish consistency in the creation and issue of transfer of care acute inpatient discharge documents. + +Page contents +Top of page +About this information standard +Current release +Supporting information +About this information standard + +This new information standard provides the guidelines to structure information in an encoded form that can support the auto population of transfer of care inpatient and day case discharge documents from acute trusts to GP Practice systems. + +The standard helps to achieve the ambitions of the NHS Digital Transfer of Care initiative, which aims to improve patient care by using the Transfer of Care Application Programming Interfaces (APIs) to share this structured information consistently between different systems and organisations across England. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the requirements specification provides further detail for those who have to implement the information standard. + +Current release +Release date 3 February 2022  +Release number Amd 75/2021 +Release title Version 1.0 +Stage Implementation (to 31 October 2022) +Key documents +Information Standards Notice (Amd 75/2021) +Requirements Specification (Amd 75/2021) +Implementation Guidance (Amd 75/2021) + +Further + +NHS Digital Transfer of Care Initiative web pages + +Supporting information + +Message from Ian Townend, Chief Architect at NHS England and NHS Improvement and Senior Responsible Owner (SRO) for the DAPB4042 standard: + +A national information standard, the Transfer of Care: Acute Inpatient Discharge has been approved by the Data Alliance Partnership Board (DAPB) and published as DAPB4042. It covers inpatient and day case discharge correspondence going from secondary care acute trusts to general practice. Its aim is to regulate the content and electronic delivery of discharge clinical information. In practice, this will remove the need for hospitals to send email attachments or paper letters requiring manual processing by general practice. + +This is the first of four messages to be approved for Transfer of Care, the others being Inpatient and Day Case Discharge Summary for Mental Health, Emergency Care Discharge Summary, and Outpatient Clinic Letter.  These are planned to go through the DAPB approval process during 2022/23. + +The DAPB4042 standard is based on FHIR (Fast Healthcare Interoperability Resources) which is a HL7 global industry standard for passing healthcare data between systems. It is free, open, and designed to be quick to learn and implement. The STU3 version of FHIR is used for DAPB4042.   + +Considerable work has been undertaken by suppliers and care provider organisations to implement this Transfer of Care message in STU3 which was the current version of FHIR at the time of development.  Plans for the next release will include alignment with the latest version of FHIR at the time of publication. This will also enable alignment with the DAPB4013: Medicine and Allergy/Intolerance Data Transfer standard which is based on FHIR R4. + +Feedback from suppliers and timescales to migrate to the latest version of FHIR mean that in order to obtain the benefits this standard brings we decided to keep to the STU3 version. We are looking into services and support to transform messages between versions of FHIR. + +Last edited: 4 February 2022 10:52 am \ No newline at end of file diff --git a/baselineTexts/transfer-of-care-emergency-care-discharge-fhir-api.txt b/baselineTexts/transfer-of-care-emergency-care-discharge-fhir-api.txt index 6dadd47..50b4ec4 100644 --- a/baselineTexts/transfer-of-care-emergency-care-discharge-fhir-api.txt +++ b/baselineTexts/transfer-of-care-emergency-care-discharge-fhir-api.txt @@ -1,46 +1,55 @@ -Transfer of Care Emergency Care Discharge - FHIR API +Transfer of Care Emergency Care Discharge - FHIR -Create and transmit documents containing Transfer of Care information supporting an emergency care discharge. +Send discharge information from an emergency care provider to a GP practice. Page contents Top of page Overview -API status +Status Service level Technology Interactions Overview +send emergency +care discharge +message +Emergency care system +MESH +GP system +receive emergency +care discharge +message -Use this API to create and transmit documents containing Transfer of Care information supporting an emergency care discharge. +  -An Emergency Care Discharge Summary (also known as an ITK3 Emergency Care Discharge) is an ITK3 FHIR document containing Transfer of Care information supporting a discharge typically between an emergency care department and a GP practice. +Use this integration to send discharge information from an emergency care provider to a GP practice. For example, a patient attends A&E due to abdominal pain. After diagnosis and treatment the patient is discharged by an emergency care specialist who completes and sends an Emergency Care Discharge document to the patient’s GP. -For more details see the Transfer of Care FHIR API. +This integration uses MESH to send and receive messages. It is part of a suite of Transfer of Care message specifications. -Before you begin any development work using this API, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -API status +Status -This API is stable. +This integration is in production. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. +This integration uses MESH to send and receive messages. -For more details, see FHIR. +The message payload conforms to the FHIR global standard for health care data exchange. Specifically, it conforms to FHIR STU3 and to our ITK3 Messaging Distribution standard. Interactions -For the latest interactions for this API, see the live implementable specification versions of the Transfer of Care FHIR API. +For details of the interactions for this integration, see Transfer of Care message specifications. For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 4:38 pm \ No newline at end of file +Last edited: 14 October 2022 10:09 am \ No newline at end of file diff --git a/baselineTexts/transfer-of-care-inpatient-discharge-fhir-api.txt b/baselineTexts/transfer-of-care-inpatient-discharge-fhir-api.txt index 0f1818a..95e231e 100644 --- a/baselineTexts/transfer-of-care-inpatient-discharge-fhir-api.txt +++ b/baselineTexts/transfer-of-care-inpatient-discharge-fhir-api.txt @@ -1,48 +1,53 @@ -Transfer of Care Inpatient Discharge - FHIR API +Transfer of Care Inpatient Discharge - FHIR Create and transmit documents containing Transfer of Care information supporting an inpatient discharge. Page contents Top of page Overview -API status +Status Service level Technology Interactions Overview +Inpatient or day case system +MESH +GP system +send patient discharge summary +receive patient discharge summary -Use this API to create and transmit documents containing Transfer of Care information supporting an inpatient discharge. +  + +Use this integration to create and transmit documents containing Transfer of Care information supporting an inpatient and day case discharge. An Inpatient and Day Case Discharge Summary Document (also known as an ITK3 eDischarge) is an ITK3 FHIR document containing Transfer of Care information supporting inpatient and day case discharges typically between an acute hospital and a GP practice. For example, a patient attends hospital for elective hip replacement surgery and is discharged by her consultant after a couple of days. The consultant completes and sends an eDischarge document to her GP. -For more details see the Transfer of Care FHIR API. +This integration uses MESH to send and receive messages. It is part of a suite of Transfer of Care FHIR message specifications. -Before you begin any development work using this API, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -API status +Status -This API is stable. +This integration is in production. Service level -This API uses MESH which is a silver service,  meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service,  meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. +This integration uses MESH to send and receive messages. -For more details, see FHIR. +The message payload conforms to the FHIR global standard for health care data exchange. Specifically, it conforms to FHIR STU3 and to our ITK3 Messaging Distribution standard. Interactions -For the latest interactions for this API, see the live implementable specification versions of the Transfer of Care FHIR API. +For details of the interactions for this integration, see Transfer of Care message specifications. For details on the general structure of the interactions, see FHIR. -Transfer of Care Inpatient Discharge - FHIR API - -Last edited: 26 May 2022 4:39 pm \ No newline at end of file +Last edited: 14 October 2022 10:09 am \ No newline at end of file diff --git a/baselineTexts/transfer-of-care-mental-health-discharge-fhir-api.txt b/baselineTexts/transfer-of-care-mental-health-discharge-fhir-api.txt index fc57e43..e8e0e26 100644 --- a/baselineTexts/transfer-of-care-mental-health-discharge-fhir-api.txt +++ b/baselineTexts/transfer-of-care-mental-health-discharge-fhir-api.txt @@ -1,46 +1,54 @@ -Transfer of Care Mental Health Discharge - FHIR API +Transfer of Care Mental Health Discharge - FHIR Create and transmit documents containing Transfer of Care information supporting a mental health discharge. Page contents Top of page Overview -API status +Status Service level Technology Interactions Overview +Inpatient or day case system +MESH +GP system +send mental +health adult discharge summary +receive mental health adult discharge summary -Use this API to create and transmit documents containing Transfer of Care information supporting a mental health discharge. +  + +Use this integration to create and transmit documents containing Transfer of Care information supporting a mental health discharge. An Inpatient and Day Case Discharge Summary (Mental Health) Document (also known as an ITK3 Mental Health Discharge) is an ITK3 FHIR document containing Transfer of Care information supporting a mental health adult discharge summary to a GP practice. For example, following an apparent overdose, a patient is admitted to a psychiatric ward for evaluation and treatment which is successful. He is discharged and the consultant sends a copy of the Mental Health Discharge to his GP. -For more details see the Transfer of Care FHIR API. +This API is a messaging API which uses MESH to send and receive messages. It is part of a suite of Transfer of Care FHIR message specifications. -Before you begin any development work using this API, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -API status +Status -This API is stable. +This integration is in production. Service level -This API uses MESH which is a silver service,  meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service,  meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. +This integration uses MESH to send and receive messages. -For more details, see FHIR. +The message payload conforms to the FHIR global standard for health care data exchange. Specifically, it conforms to FHIR STU3 and to our ITK3 Messaging Distribution standard. Interactions -For the latest interactions for this API, see the live implementable specification versions of the Transfer of Care FHIR API. +For details of the interactions for this integration, see Transfer of Care message specifications. For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 4:41 pm \ No newline at end of file +Last edited: 14 October 2022 10:11 am \ No newline at end of file diff --git a/baselineTexts/transfer-of-care-outpatient-clinic-letter-fhir-api.txt b/baselineTexts/transfer-of-care-outpatient-clinic-letter-fhir-api.txt index 98c9f51..7b9607a 100644 --- a/baselineTexts/transfer-of-care-outpatient-clinic-letter-fhir-api.txt +++ b/baselineTexts/transfer-of-care-outpatient-clinic-letter-fhir-api.txt @@ -1,46 +1,53 @@ -Transfer of Care Outpatient Clinic Letter - FHIR API +Transfer of Care Outpatient Clinic Letter - FHIR Create and transmit documents containing Transfer of Care information following an outpatient consultation in a clinic. Page contents Top of page Overview -API status +Status Service level Technology Interactions Overview +Outpatient clinic system +MESH +NHS healthcare systems +send outpatient clinic letter +receive outpatient clinic letter -Use this API to create and transmit documents containing Transfer of Care information following an outpatient consultation in a clinic. +  + +Use this integration to create and transmit documents containing Transfer of Care information following an outpatient consultation in a clinic. An Outpatient Clinic Letter (also known as an ITK3 Outpatient Letter) is an ITK3 FHIR document containing Transfer of Care information from the hospital to the patient's GP and other relevant parties following a consultation in a clinic. For example, a patient suffering from double vision is referred to an eye hospital and subsequently attends their outpatient appointment. Investigations indicate hypertropia, and the ophthalmologist recommends glasses fitted with prisms for treatment. The ophthalmologist completes and sends an Outpatient Clinic Letter to her GP. -For more details see the Transfer of Care FHIR API. +This integration uses MESH to send and receive messages. It is part of a suite of Transfer of Care FHIR specifications. -Before you begin any development work using these API standards, contact us to discuss your best options. +Before you begin any development work using this integration, contact us to discuss your best options. -API status +Status -This API is stable. +This integration is stable. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. +This integration uses MESH to send and receive messages. -For more details, see FHIR. +The message payload conforms to the FHIR global standard for health care data exchange. Specifically, it conforms to FHIR STU3 and to our ITK3 Messaging Distribution standard. Interactions -For the latest interactions for this API, see the live implementable specification versions of the Transfer of Care FHIR API. +For details of the interactions for this integration, see Transfer of Care message specifications. For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 4:42 pm \ No newline at end of file +Last edited: 21 July 2022 9:52 am \ No newline at end of file diff --git a/baselineTexts/treatment-function-and-main-specialty-standard.txt b/baselineTexts/treatment-function-and-main-specialty-standard.txt index 8721f7d..3f12473 100644 --- a/baselineTexts/treatment-function-and-main-specialty-standard.txt +++ b/baselineTexts/treatment-function-and-main-specialty-standard.txt @@ -50,11 +50,11 @@ Key documents Information Standards Notice (Amd 17/2012) Specification (Amd 17/2012) Change Request (Amd 17/2012) -Technical Specification (Amd 17/2012) +Technical Specification (Amd 17/2012) [Archive Content] Supporting documents  NHS Data Model and Dictionary Change Request 1286 (Amd 17/2012) -Guidance (Amd 17/2012) +Guidance (Amd 17/2012) [Archive Content] Maintenance Plan (Amd 17/2012) Treatment Function Maintenance Group Terms of Reference (Amd 17/2012) Treatment Function Maintenance Group Acceptance Criteria (Amd 17/2012) diff --git a/baselineTexts/uk-core-fast-healthcare-interoperability-resources-fhir-release-4-r4-governance.txt b/baselineTexts/uk-core-fast-healthcare-interoperability-resources-fhir-release-4-r4-governance.txt new file mode 100644 index 0000000..8b58b0c --- /dev/null +++ b/baselineTexts/uk-core-fast-healthcare-interoperability-resources-fhir-release-4-r4-governance.txt @@ -0,0 +1,34 @@ +DAPB4020: UK Core Fast Healthcare Interoperability Resources (FHIR) Release 4 (R4) Governance + +This information standard facilitates interoperability in the sharing of data across the NHS, health services and adult social care in England. + +Page contents +Top of page +About this information standard +Current release +Contacts +About this information standard + +This new information standard formally introduces the governance process for the oversight, direction and leadership of the UK Core Fast Healthcare Interoperability Resources (FHIR) Release 4. The standard mandates, within the health and care sector in England, a consistent approach to the development of UK Core resources, thereby facilitating clear interoperability in the sharing of data across the NHS, health services and adult social care in England. + +This information standard is published under section 250 of the Health and Social Care Act 2012. An Information Standards Notice (see below) provides an overview of scope and implementation timescales, and the requirements specification provides further detail for those who have to implement the information standard. + +Current release +Release date 11 March 2022  +Release number Amd 33/2021 +Release title Initial standard +Key documents +Information Standards Notice (Amd 33/2021) +Specification and Guidance (Amd 33/2021) + +Further + +NHS Digital FHIR resources + +Contacts + +For information relating to the UK Core governance process please email the HL7 UK Secretariat: secretariat@hl7.org.uk + +For information relating to Clinical and Technical Assurance and the development and release of UK Core assets, please email the NHS Digital Interoperability Standards Team (IOPS): interoperabilityteam@nhs.net + +Last edited: 11 March 2022 3:33 pm \ No newline at end of file diff --git a/baselineTexts/urgent-referral-from-care-home-to-hospital.txt b/baselineTexts/urgent-referral-from-care-home-to-hospital.txt index 7efd7b9..4700f74 100644 --- a/baselineTexts/urgent-referral-from-care-home-to-hospital.txt +++ b/baselineTexts/urgent-referral-from-care-home-to-hospital.txt @@ -31,6 +31,7 @@ Royal College of Nursing Royal College of Occupational Therapists Royal College of Physicians Royal Pharmaceutical Society +View the standard Urgent transfer from care home to hospital v1.2 V1.2 View the standard V1.2 Download the standard (xlsx file) @@ -38,7 +39,7 @@ V1.2 Release notes Supporting documents Implementation guidance Digital social care final report -Survey 2 Report +Hazard log Hazard log Safety case report IHRIM record correction guidance diff --git a/baselineTexts/vaccination-adverse-reactions-covid-19-api.txt b/baselineTexts/vaccination-adverse-reactions-covid-19-api.txt index a723550..bd70b0d 100644 --- a/baselineTexts/vaccination-adverse-reactions-covid-19-api.txt +++ b/baselineTexts/vaccination-adverse-reactions-covid-19-api.txt @@ -1,13 +1,13 @@ -Vaccination Adverse Reactions COVID-19 API +Vaccination Adverse Reactions COVID-19 Provide information to NHS Digital on adverse reactions relating to coronavirus (COVID-19) vaccinations. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -16,14 +16,21 @@ Environments and testing Onboarding Interactions Overview +Point-of-care application +MESH +NHS Digital +send vaccination adverse reaction information +receive vaccination adverse reaction information -Use this API to provide information to us at NHS Digital on adverse reactions. +  + +Use this integration to provide information to us at NHS Digital on adverse reactions. You can send us information on adverse reactions relating to:  coronavirus (COVID-19) vaccinations. -This API specifies the flow of information relating to vaccination-related adverse reactions from any healthcare setting including: +This integration specifies the flow of information relating to vaccination-related adverse reactions from any healthcare setting including: hospital hubs - NHS providers vaccinating on site  @@ -31,9 +38,9 @@ local vaccine services – community or primary care led services which could i vaccination centres – large sites such as sports and conference venues set up for high volumes of people  -This API consists of pipe-delimited files to send us over MESH. +This integration uses MESH to send pipe-delimited files to us. -For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR API. +For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR. Regulatory reporting @@ -43,50 +50,50 @@ At NHS Digital, we must share this information with the Medicines and Healthcare The information we share with MHRA as part of this scheme is anonymised. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development, by contacting us. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development, by contacting us. You must do this before you can go live (see ‘Onboarding’ below).  Related APIs -The following APIs are also related to this one: +The following APIs and integrations are also related to this one: -Vaccination API - use this to provide information to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2020-21 vaccinations -Vaccination Events - FHIR API - use this to publish and receive messages about changes to a patient's vaccination details -Digital Medicine - FHIR API - use this to notify a patient's registered GP practice of care services provided by a pharmacy, such as immunisation -API status +Vaccination - use this to provide information to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2020-21 vaccinations +Vaccination Events - FHIR - use this to publish and receive messages about changes to a patient's vaccination details +Digital Medicine - FHIR - use this to notify a patient's registered GP practice of care services provided by a pharmacy, such as immunisation +Status -This API is stable. +This integration is stable. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API specifies pipe-delimited files sent over MESH. +This integration specifies pipe-delimited files sent over MESH. For more details, see MESH. Network access -This API is available on the internet and on the Health and Social Care Network (HSCN). +This integration is available on the internet and on the Health and Social Care Network (HSCN). For more details see Network access for APIs. Security and authorisation -This API uses MESH which is an application-restricted API. +This integration uses MESH which is an application-restricted API. -This APIs does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them.  +This integration does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them.  Environments and testing -This API uses MESH. +This integration uses MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. @@ -108,6 +115,4 @@ Adverse Reaction specification V1.1 - COVID-19 DOCX 444 KB -Vaccination Adverse Reactions COVID-19 API - -Last edited: 26 May 2022 4:45 pm \ No newline at end of file +Last edited: 21 July 2022 9:53 am \ No newline at end of file diff --git a/baselineTexts/vaccination-apis.txt b/baselineTexts/vaccination-apis.txt index f60f767..58cf130 100644 --- a/baselineTexts/vaccination-apis.txt +++ b/baselineTexts/vaccination-apis.txt @@ -1,13 +1,13 @@ -Vaccination APIs +Vaccination -Provide information to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2021-22 vaccinations. +Provide information to us at NHS Digital relating to coronavirus (COVID-19) and seasonal flu vaccinations. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -18,18 +18,25 @@ Latest addenda Interactions Additional guidance Overview +Point-of-care application +MESH +NHS Digital +send vaccination data files +receive vaccination data files -Use these APIs to provide vaccination information to us at NHS Digital. +  + +Use these integrations to provide vaccination information to us at NHS Digital. You can send us information relating to: coronavirus (COVID-19) vaccinations COVID-19 extended data attributes COVID-19 hourly vaccination aggregate data for the NHS Foundry -seasonal flu 2021-22 vaccinations +seasonal flu vaccinations measles, mumps and rubella (MMR) vaccinations -These APIs specify the flow of vaccination-related information from healthcare settings including: +These integrations specify the flow of vaccination-related information from healthcare settings including: hospital hubs - NHS providers vaccinating on site  @@ -37,58 +44,58 @@ local vaccine services – community or primary care led services which could i vaccination centres – large sites such as sports and conference venues set up for high volumes of people  -These APIs consist of delimited files sent to us over MESH. +These integrations use MESH to send and receive pipe-delimited (|) and not-sign-delimited (¬) files. For more details on how to interact with end users to collect COVID-19 information safely, see the functional specifications under 'Additional guidance'. -For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR API. +For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR. -For FHIR standards relating to the flow of information to other care providers such as Child Health, see Vaccination Events - FHIR API. +For FHIR standards relating to the flow of information to other care providers such as Child Health, see Vaccination Events - FHIR. -Who can use this API +Who can use this -These APIs can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development, by contacting us. +These integrations can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development, by contacting us. You must do this before you can go live (see ‘Onboarding’ below).  Related APIs -The following APIs are also related to these: +The following APIs and integrations are also related to these integrations : -Vaccination Adverse Reactions COVID-19 API - use this to provide information to NHS Digital on adverse reactions relating to coronavirus (COVID-19) vaccinations. -Vaccination Events - FHIR API - use this to send and receive messages about changes to a patient's vaccination details. -Digital Medicine - FHIR API - use this to notify a patient's registered GP practice of care services provided by a pharmacy, such as immunisation. -API status +Vaccination Adverse Reactions COVID-19 - use this to provide information to NHS Digital on adverse reactions relating to coronavirus (COVID-19) vaccinations. +Vaccination Events - FHIR - use this to send and receive messages about changes to a patient's vaccination details. +Digital Medicine - FHIR - use this to notify a patient's registered GP practice of care services provided by a pharmacy, such as immunisation. +Status -These APIs are stable. +These integrations are stable. Service level -This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +These integrations uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -These APIs consist of delimited files you send to us over MESH. +These integrations consist of delimited files you send to us over MESH. -Some are pipe-delimited, others are not-sign-delimited files. For details, see the individual specification. +Some are pipe-delimited (|), others are not-sign-delimited (¬) files. For details, see the individual specification. Network access -These APIs are available on the internet and on the Health and Social Care Network (HSCN). +These integrations are available on the internet and on the Health and Social Care Network (HSCN). For more details see Network access for APIs. Security and authorisation -These APIs use MESH which is an application-restricted API. +These integrations use MESH which is an application-restricted API. -These APIs do not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them.  +These integrations do not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them.  Environments and testing -These APIs use MESH. +These integrations use MESH. As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API. @@ -106,45 +113,29 @@ Latest addenda These are Microsoft Word files. To request a different format, contact us. -Removal of £10 supplementary payment for severely immunosuppressed individuals V1.0 +  -DOCX 96 KB +PoC system updates to accommodate COVID-19 autumn booster and seasonal flu vaccinations V1.2 + +DOCX 110 KB -POC system updates to accommodate COVID-19 vaccinations with Comirnaty® Ready to Use V1.1 +POC dormancy status for closing sites, hibernating or pausing sites, and sites transferring to a new POC provider V1.0 -DOCX 112 KB +DOCX 89 KB POC to restrict retrospective COVID-19 vaccination event record entries V1.0 DOCX 86 KB -Vaxzevria® (AstraZeneca) Vaccine Rebranding V1.1 - -DOCX 101 KB - -POC system updates to accommodate reporting of COVID-19 vaccinations for 5 to 11 children not at risk V1.0 - -DOCX 96 KB - -POC system updates to support subsequent boosters V1.0 - -DOCX 93 KB - -POC system updates to accommodate COVID-19 vaccinations for ‘at-risk’ 5 to 11 children V1.2 - -DOCX 117 KB - -PoC system updates to accommodate COVID-19 vaccinations for 12 year olds in school year 7 - -DOCX 107 KB - -POC to display full vaccination history +POC to display full vaccination history V1.0 DOCX 96 KB Interactions These are Microsoft Word files. To request a different format, contact us. +  + Extended attributes for additional data capture V1.5 DOCX 437 KB @@ -157,33 +148,31 @@ MMR vaccination - technical specification for GPIT suppliers to NHS Digital deli DOCX 489 KB -NHS Digital daily clinical vaccination extract technical specification v4.0 approved +Daily clinical vaccination extract technical specification v4.1 -DOCX 470 KB +DOCX 477 KB Additional guidance Use these functional specifications to understand how your system must interact with end users in order to collect information safely and assist in decision making, relating to COVID-19 vaccinations. -These are Microsoft Word files. To request a different format, contact us.   - -Functional specification for capture of clinical screening questions at point of care V3.4 - COVID-19 +These are Microsoft Word files. To request a different format, contact us. -DOCX 430 KB +  -Functional specification for immunisation status V1.0 - flu and COVID-19 +Overall specification for point of care systems V5.0 -DOCX 970 KB +DOCX 3 MB -NHS Digital Functional Spec for Additional PoC Data Capture v3.0 Approved +Functional specification for additional POC data capture V4.2 -DOCX 444 KB +DOCX 447 KB -Overall specification for point of care systems V4.0 – COVID-19 +Functional specification for capture of clinical screening questions at point of care V4.0 - COVID-19 -DOCX 2 MB +DOCX 443 KB -Vaccine specific information for suppliers of point of care systems V3.2 - COVID-19 +Vaccine specific information for suppliers of point of care systems V3.6 - COVID-19 -DOCX 427 KB +DOCX 441 KB -Last edited: 26 May 2022 4:46 pm \ No newline at end of file +Last edited: 10 October 2022 5:48 pm \ No newline at end of file diff --git a/baselineTexts/vaccination-events-fhir-api.txt b/baselineTexts/vaccination-events-fhir-api.txt index 9b6f325..afebeca 100644 --- a/baselineTexts/vaccination-events-fhir-api.txt +++ b/baselineTexts/vaccination-events-fhir-api.txt @@ -1,13 +1,13 @@ -Vaccination Events - FHIR API +Vaccination Events - FHIR Publish or receive messages about changes to a patient's vaccination details. Page contents Top of page Overview -Who can use this API +Who can use this Related APIs -API status +Status Service level Technology Network access @@ -16,8 +16,29 @@ Environments and testing Onboarding Interactions Overview +Sending System -Use this API to publish or receive messages about changes to a patient's vaccination details, including: +NEMS +publish event +MESH + +send event to all +subscribing systems + +Subscribed +System B + +Subscribed +System A + +Subscribed +System C + +manage subscriptions + +  + +Use this integration to publish or receive messages about changes to a patient's vaccination details, including: new vaccinations updated vaccination details @@ -27,13 +48,13 @@ This service currently covers childhood vaccinations up to the age of 19, and Using a publish-subscribe model, we share information about these events with healthcare workers in other organisations such as GPs, Emergency Departments and Local Authorities. -To send messages, use this API. To receive these messages you need to subscribe to them via National Events Management Service (NEMS) and collect them via MESH. +This integration uses a publish-subscribe model - the sending system publishes events to National Events Management Service (NEMS), and NEMS forwards the events to all subscribed systems via MESH. For example, when a GP system records a vaccination, it sends an event message containing the vaccination details to NEMS. NEMS then sends the message to all healthcare workers who have subscribed to receive vaccination event messages. -Who can use this API +Who can use this -This API can only be used where there is a legal basis to do so. +This integration can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. To do this, contact us.  @@ -43,30 +64,28 @@ You must do this before you can go live (see 'Onboarding' below). Related APIs -The following APIs are also related to this API: - -National Events Management Service (NEMS) API - use this API to publish and subscribe to patient-centric event messages -Message Exchange for Social Care and Health (MESH) API - use this API to collect events that you subscribed to - -Digital Child Health - FHIR API - use this API to share information about a child's health between healthcare workers +The following APIs and integrations are also related to this integration: -API status +National Events Management Service (NEMS)  - use this to publish and subscribe to patient-centric event message +Message Exchange for Social Care and Health (MESH) API - use this to collect events that you subscribed to +Digital Child Health - FHIR - use this to share information about a child's health between healthcare workers +Status -This API is stable. +This integration is stable. Service level -This API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays. +This integration is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays. For more details, see service levels. Technology -This API is a FHIR API. +This integration uses FHIR. It uses a publish-subscribe model. -Use our National Events Management Service (NEMS) API to subscribe to events. +Use our National Events Management Service (NEMS) integration to subscribe to events. Use our MESH API to collect event messages that you subscribed to. @@ -74,26 +93,26 @@ The message payload is based on the HL7 FHIR STU3 Messaging Implementation. Network access -This API is available on the internet and on the Health and Social Care Network (HSCN). +This integration is available on the internet and on the Health and Social Care Network (HSCN). For more details see Network access for APIs. Security and authorisation -This API uses NEMS and MESH APIs which are application-restricted, meaning we authenticate the calling application but not the end user. +This integration uses NEMS and MESH API which are application-restricted, meaning we authenticate the calling application but not the end user. You can use this pattern as follows: unattended (end user not present), for example as part of a back end process to check NHS numbers for data flowing from one system to another attended (end user present) - in which case, you must ensure the end user is authenticated and suitably authorised locally by the calling application -In particular, this API uses TLS-MA authentication. +In particular, this integration uses TLS-MA authentication. It also implements authorisation controls which restrict the event types that the connecting application can subscribe to or publish. Environments and testing -This API uses NEMS, which is available in Opentest for early development and testing. +This integration uses NEMS, which is available in Opentest for early development and testing. NEMS is also available for testing purposes in: @@ -131,18 +150,18 @@ For more details, see the NEMS onboarding guide on getting access to Opentest Onboarding -You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. +You need to get your software approved by us before it can go live with this integration. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead. -To outline your use case and start the onboarding process for this API, contact us. +To outline your use case and start the onboarding process for this integration, contact us. Interactions -For a full list of interactions for this API, see Publish an Event Message and Subscriptions Overview. +For a full list of interactions for this integration, see Publish an Event Message and Subscriptions Overview. -This API supports the following event types: +This integration supports the following event types: Vaccinations For details on the general structure of the interactions, see FHIR. -Last edited: 26 May 2022 4:46 pm \ No newline at end of file +Last edited: 21 July 2022 9:35 am \ No newline at end of file diff --git a/diff/about-me-chrome-1200x900-dpr-1.png b/diff/about-me-chrome-1200x900-dpr-1.png index 051c269..24e48f3 100644 Binary files a/diff/about-me-chrome-1200x900-dpr-1.png and b/diff/about-me-chrome-1200x900-dpr-1.png differ diff --git a/diff/accessible-information-chrome-1200x900-dpr-1.png b/diff/accessible-information-chrome-1200x900-dpr-1.png index 0e00014..e83638a 100644 Binary files a/diff/accessible-information-chrome-1200x900-dpr-1.png and b/diff/accessible-information-chrome-1200x900-dpr-1.png differ diff --git a/diff/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png b/diff/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png index c90fdca..77d420a 100644 Binary files a/diff/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png and b/diff/aidc-automatic-identification-and-data-capture-chrome-1200x900-dpr-1.png differ diff --git a/diff/aidc-for-patient-identification-chrome-1200x900-dpr-1.png b/diff/aidc-for-patient-identification-chrome-1200x900-dpr-1.png index d338dcd..0e8c5a2 100644 Binary files a/diff/aidc-for-patient-identification-chrome-1200x900-dpr-1.png and b/diff/aidc-for-patient-identification-chrome-1200x900-dpr-1.png differ diff --git a/diff/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png b/diff/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png index 6f24ff7..ee955b8 100644 Binary files a/diff/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png and b/diff/ambulance-handover-to-emergency-care-chrome-1200x900-dpr-1.png differ diff --git a/diff/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png b/diff/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png index 77395c1..3da7bb9 100644 Binary files a/diff/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png and b/diff/anonymisation-standard-for-publishing-health-and-social-care-data-chrome-1200x900-dpr-1.png differ diff --git a/diff/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png b/diff/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png index 07a4dcc..7bd9f3c 100644 Binary files a/diff/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png and b/diff/assessment-discharge-and-withdrawal-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png b/diff/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png index d61d88a..dc50c2b 100644 Binary files a/diff/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png and b/diff/assessment-discharge-and-withdrawal-notices-between-hospitals-and-social-services-chrome-1200x900-dpr-1.png differ diff --git a/diff/birth-notifications-chrome-1200x900-dpr-1.png b/diff/birth-notifications-chrome-1200x900-dpr-1.png index 5bf0ef2..089e927 100644 Binary files a/diff/birth-notifications-chrome-1200x900-dpr-1.png and b/diff/birth-notifications-chrome-1200x900-dpr-1.png differ diff --git a/diff/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png b/diff/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png index 1fbf1fe..eaeac9f 100644 Binary files a/diff/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png and b/diff/bowel-cancer-screening-edifact-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png b/diff/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png index c1cc01b..16a88f7 100644 Binary files a/diff/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png and b/diff/care-connect-fhir-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png b/diff/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png index 21e56a6..a7a637d 100644 Binary files a/diff/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png and b/diff/care-homes-view-of-shared-care-records-chrome-1200x900-dpr-1.png differ diff --git a/diff/child-protection-information-sharing-chrome-1200x900-dpr-1.png b/diff/child-protection-information-sharing-chrome-1200x900-dpr-1.png index b97e9e4..5b84c6d 100644 Binary files a/diff/child-protection-information-sharing-chrome-1200x900-dpr-1.png and b/diff/child-protection-information-sharing-chrome-1200x900-dpr-1.png differ diff --git a/diff/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png b/diff/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png index 7952c5e..575d535 100644 Binary files a/diff/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png and b/diff/clinical-decision-support-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/clinical-referral-information-chrome-1200x900-dpr-1.png b/diff/clinical-referral-information-chrome-1200x900-dpr-1.png index 6f1dd33..f80ff1d 100644 Binary files a/diff/clinical-referral-information-chrome-1200x900-dpr-1.png and b/diff/clinical-referral-information-chrome-1200x900-dpr-1.png differ diff --git a/diff/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png b/diff/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png index 1391111..6b20be2 100644 Binary files a/diff/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png and b/diff/clinical-risk-management-its-application-in-the-deployment-and-use-of-health-it-systems-chrome-1200x900-dpr-1.png differ diff --git a/diff/community-pharmacy-chrome-1200x900-dpr-1.png b/diff/community-pharmacy-chrome-1200x900-dpr-1.png index eb9fab2..b65f212 100644 Binary files a/diff/community-pharmacy-chrome-1200x900-dpr-1.png and b/diff/community-pharmacy-chrome-1200x900-dpr-1.png differ diff --git a/diff/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png b/diff/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png index 9fbf3a9..d6878c8 100644 Binary files a/diff/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png and b/diff/compliance-with-national-data-opt-outs-chrome-1200x900-dpr-1.png differ diff --git a/diff/core-information-standard-chrome-1200x900-dpr-1.png b/diff/core-information-standard-chrome-1200x900-dpr-1.png index 4712c9f..ba813aa 100644 Binary files a/diff/core-information-standard-chrome-1200x900-dpr-1.png and b/diff/core-information-standard-chrome-1200x900-dpr-1.png differ diff --git a/diff/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png b/diff/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png index f403508..597c947 100644 Binary files a/diff/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png and b/diff/dictionary-of-medicines-and-devices-dmd-chrome-1200x900-dpr-1.png differ diff --git a/diff/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png b/diff/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png index bb9f366..164082b 100644 Binary files a/diff/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png and b/diff/digital-child-health-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/digital-maternity-api-standards-chrome-1200x900-dpr-1.png b/diff/digital-maternity-api-standards-chrome-1200x900-dpr-1.png index 68bf75c..2707fb8 100644 Binary files a/diff/digital-maternity-api-standards-chrome-1200x900-dpr-1.png and b/diff/digital-maternity-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/digital-maternity-record-standard-chrome-1200x900-dpr-1.png b/diff/digital-maternity-record-standard-chrome-1200x900-dpr-1.png index abd1d5c..2cb140a 100644 Binary files a/diff/digital-maternity-record-standard-chrome-1200x900-dpr-1.png and b/diff/digital-maternity-record-standard-chrome-1200x900-dpr-1.png differ diff --git a/diff/document-naming-chrome-1200x900-dpr-1.png b/diff/document-naming-chrome-1200x900-dpr-1.png index 55d2ec3..7c38eb2 100644 Binary files a/diff/document-naming-chrome-1200x900-dpr-1.png and b/diff/document-naming-chrome-1200x900-dpr-1.png differ diff --git a/diff/dose-syntax-api-standards-chrome-1200x900-dpr-1.png b/diff/dose-syntax-api-standards-chrome-1200x900-dpr-1.png index e552116..f376c86 100644 Binary files a/diff/dose-syntax-api-standards-chrome-1200x900-dpr-1.png and b/diff/dose-syntax-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/edischarge-summary-chrome-1200x900-dpr-1.png b/diff/edischarge-summary-chrome-1200x900-dpr-1.png index 77bacaa..9b9a86a 100644 Binary files a/diff/edischarge-summary-chrome-1200x900-dpr-1.png and b/diff/edischarge-summary-chrome-1200x900-dpr-1.png differ diff --git a/diff/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png b/diff/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png index a0b9541..42e3a6b 100644 Binary files a/diff/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png and b/diff/electronic-prescribing-and-medicines-administration-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png b/diff/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png index 6abcbc9..4a45b35 100644 Binary files a/diff/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png and b/diff/electronic-yellow-card-reporting-version-30-chrome-1200x900-dpr-1.png differ diff --git a/diff/emergency-care-discharge-chrome-1200x900-dpr-1.png b/diff/emergency-care-discharge-chrome-1200x900-dpr-1.png index 041c626..b23f88d 100644 Binary files a/diff/emergency-care-discharge-chrome-1200x900-dpr-1.png and b/diff/emergency-care-discharge-chrome-1200x900-dpr-1.png differ diff --git a/diff/end-of-life-api-standards-chrome-1200x900-dpr-1.png b/diff/end-of-life-api-standards-chrome-1200x900-dpr-1.png index dd9a876..4a1598b 100644 Binary files a/diff/end-of-life-api-standards-chrome-1200x900-dpr-1.png and b/diff/end-of-life-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png b/diff/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png index ba7628a..842c48b 100644 Binary files a/diff/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png and b/diff/fgm-information-sharing-fgm-is-local-system-integration-chrome-1200x900-dpr-1.png differ diff --git a/diff/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png b/diff/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png index ad1913b..bc6f830 100644 Binary files a/diff/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png and b/diff/gp-connect-access-document-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png b/diff/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png index a30a8b9..aca0d8a 100644 Binary files a/diff/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png and b/diff/gp-connect-access-record-html-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png b/diff/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png index d0f2248..52a2023 100644 Binary files a/diff/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png and b/diff/gp-connect-access-record-structured-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png b/diff/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png index 7bdab0d..059b991 100644 Binary files a/diff/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png and b/diff/gp-connect-appointment-management-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png b/diff/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png index 36dd2f4..ba69483 100644 Binary files a/diff/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png and b/diff/gp-connect-send-document-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png b/diff/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png index 2805d78..e698994 100644 Binary files a/diff/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png and b/diff/gp2gp-hl7-v3-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png b/diff/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png index 254c25d..0b26e2f 100644 Binary files a/diff/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png and b/diff/health-and-social-care-organisation-reference-data-chrome-1200x900-dpr-1.png differ diff --git a/diff/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png b/diff/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png index 8d51251..57fcf1a 100644 Binary files a/diff/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png and b/diff/healthcare-resource-groups-hrg-chrome-1200x900-dpr-1.png differ diff --git a/diff/healthy-child-record-chrome-1200x900-dpr-1.png b/diff/healthy-child-record-chrome-1200x900-dpr-1.png index a53bd26..97b5adc 100644 Binary files a/diff/healthy-child-record-chrome-1200x900-dpr-1.png and b/diff/healthy-child-record-chrome-1200x900-dpr-1.png differ diff --git a/diff/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png b/diff/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png index 6da16fa..0ecd08b 100644 Binary files a/diff/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png and b/diff/hospital-referral-for-assessment-for-community-care-and-support-chrome-1200x900-dpr-1.png differ diff --git a/diff/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png b/diff/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png index aaaf12e..38f7a59 100644 Binary files a/diff/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png and b/diff/identity-verification-and-authentication-standard-for-digital-health-and-care-services-chrome-1200x900-dpr-1.png differ diff --git a/diff/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png b/diff/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png index 4eac734..b1e90c9 100644 Binary files a/diff/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png and b/diff/information-provided-by-local-authorities-in-shared-care-records-chrome-1200x900-dpr-1.png differ diff --git a/diff/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png b/diff/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png index e70346d..5e5064a 100644 Binary files a/diff/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png and b/diff/information-sharing-to-tackle-violence-chrome-1200x900-dpr-1.png differ diff --git a/diff/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png b/diff/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png index 7eff6d0..db48c0d 100644 Binary files a/diff/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png and b/diff/interim-clinical-imaging-procedure-codes-chrome-1200x900-dpr-1.png differ diff --git a/diff/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png b/diff/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png index 4f5dfc5..740594f 100644 Binary files a/diff/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png and b/diff/international-statistical-classification-of-diseases-and-related-health-problems-icd-10-chrome-1200x900-dpr-1.png differ diff --git a/diff/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png b/diff/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png index 54a030b..9ce45dd 100644 Binary files a/diff/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png and b/diff/interoperability-toolkit-3-messaging-distribution-fhir-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png b/diff/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png index f85a06e..4322e07 100644 Binary files a/diff/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png and b/diff/interoperability-toolkit-messaging-hl7-v2-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png b/diff/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png index b6dfe0b..dbf311b 100644 Binary files a/diff/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png and b/diff/medicine-and-allergyintolerance-data-transfer-chrome-1200x900-dpr-1.png differ diff --git a/diff/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png b/diff/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png index acec55d..0c850db 100644 Binary files a/diff/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png and b/diff/mental-health-inpatient-discharge-chrome-1200x900-dpr-1.png differ diff --git a/diff/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png b/diff/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png index 8f03617..75855cf 100644 Binary files a/diff/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png and b/diff/national-early-warning-score-2-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png b/diff/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png index 5b7fefd..18ebd3e 100644 Binary files a/diff/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png and b/diff/national-health-application-and-infrastructure-services-nhais-gp-links-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png b/diff/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png index 1728818..7037565 100644 Binary files a/diff/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png and b/diff/national-record-locator-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/nhs-111-api-standard-chrome-1200x900-dpr-1.png b/diff/nhs-111-api-standard-chrome-1200x900-dpr-1.png index 3bda25d..f108c93 100644 Binary files a/diff/nhs-111-api-standard-chrome-1200x900-dpr-1.png and b/diff/nhs-111-api-standard-chrome-1200x900-dpr-1.png differ diff --git a/diff/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png b/diff/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png index fe55ab1..db314df 100644 Binary files a/diff/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png and b/diff/nhs-booking-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/nhs-number-chrome-1200x900-dpr-1.png b/diff/nhs-number-chrome-1200x900-dpr-1.png index 5edee25..5dd97ba 100644 Binary files a/diff/nhs-number-chrome-1200x900-dpr-1.png and b/diff/nhs-number-chrome-1200x900-dpr-1.png differ diff --git a/diff/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png b/diff/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png index 5edee25..5dd97ba 100644 Binary files a/diff/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png and b/diff/nhs-number-for-general-practice-chrome-1200x900-dpr-1.png differ diff --git a/diff/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png b/diff/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png index 5edee25..5dd97ba 100644 Binary files a/diff/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png and b/diff/nhs-number-for-secondary-care-chrome-1200x900-dpr-1.png differ diff --git a/diff/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png b/diff/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png index e1eb4c8..342f974 100644 Binary files a/diff/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png and b/diff/opcs-classification-of-interventions-and-procedures-chrome-1200x900-dpr-1.png differ diff --git a/diff/outpatient-letter-chrome-1200x900-dpr-1.png b/diff/outpatient-letter-chrome-1200x900-dpr-1.png index dcdf078..0c6b665 100644 Binary files a/diff/outpatient-letter-chrome-1200x900-dpr-1.png and b/diff/outpatient-letter-chrome-1200x900-dpr-1.png differ diff --git a/diff/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png b/diff/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png index 0ff81bd..b753236 100644 Binary files a/diff/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png and b/diff/overseas-visitor-charging-category-chrome-1200x900-dpr-1.png differ diff --git a/diff/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png b/diff/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png index 1509b2e..977439e 100644 Binary files a/diff/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png and b/diff/palliative-care-co-ordination-core-content-chrome-1200x900-dpr-1.png differ diff --git a/diff/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png b/diff/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png index e5d82a3..fe878ef 100644 Binary files a/diff/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png and b/diff/pathology-messaging-edifact-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png b/diff/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png index dc28f40..f5856f5 100644 Binary files a/diff/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png and b/diff/pathology-messaging-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png b/diff/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png index 735f7bb..73ba32e 100644 Binary files a/diff/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png and b/diff/pathology-messaging-hl7-v3-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png b/diff/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png index 13bc205..82c5e28 100644 Binary files a/diff/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png and b/diff/pathology-test-and-results-standard-chrome-1200x900-dpr-1.png differ diff --git a/diff/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png b/diff/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png index 41b1217..ca31016 100644 Binary files a/diff/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png and b/diff/patient-identifiers-for-identity-bands-chrome-1200x900-dpr-1.png differ diff --git a/diff/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png b/diff/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png index a2c0491..9fad64e 100644 Binary files a/diff/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png and b/diff/personal-demographics-service-notifications-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png b/diff/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png index 08342c1..0a1c092 100644 Binary files a/diff/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png and b/diff/personalised-care-and-support-plan-chrome-1200x900-dpr-1.png differ diff --git a/diff/secure-email-chrome-1200x900-dpr-1.png b/diff/secure-email-chrome-1200x900-dpr-1.png index 1c69829..3be5d18 100644 Binary files a/diff/secure-email-chrome-1200x900-dpr-1.png and b/diff/secure-email-chrome-1200x900-dpr-1.png differ diff --git a/diff/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png b/diff/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png index f9cfd93..908eaab 100644 Binary files a/diff/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png and b/diff/sexual-orientation-monitoring-chrome-1200x900-dpr-1.png differ diff --git a/diff/snomed-ct-chrome-1200x900-dpr-1.png b/diff/snomed-ct-chrome-1200x900-dpr-1.png index e76d082..5440dc4 100644 Binary files a/diff/snomed-ct-chrome-1200x900-dpr-1.png and b/diff/snomed-ct-chrome-1200x900-dpr-1.png differ diff --git a/diff/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png b/diff/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png index d7ba456..f8df4b7 100644 Binary files a/diff/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png and b/diff/summary-care-record-smsp-api-standards-chrome-1200x900-dpr-1.png differ diff --git a/diff/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png b/diff/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png index 7ef17f2..7521666 100644 Binary files a/diff/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png and b/diff/transfer-of-care-emergency-care-discharge-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png b/diff/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png index 9b69d6f..8d02c3d 100644 Binary files a/diff/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png and b/diff/transfer-of-care-inpatient-discharge-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png b/diff/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png index 5bd85ae..7de1f65 100644 Binary files a/diff/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png and b/diff/transfer-of-care-mental-health-discharge-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png b/diff/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png index ee43d37..589885f 100644 Binary files a/diff/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png and b/diff/transfer-of-care-outpatient-clinic-letter-fhir-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png b/diff/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png index 108f05a..073461a 100644 Binary files a/diff/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png and b/diff/treatment-function-and-main-specialty-standard-chrome-1200x900-dpr-1.png differ diff --git a/diff/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png b/diff/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png index 67dea3e..7379fdd 100644 Binary files a/diff/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png and b/diff/urgent-referral-from-care-home-to-hospital-chrome-1200x900-dpr-1.png differ diff --git a/diff/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png b/diff/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png index be1dab2..6c7cac6 100644 Binary files a/diff/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png and b/diff/vaccination-adverse-reactions-covid-19-api-chrome-1200x900-dpr-1.png differ diff --git a/diff/vaccination-apis-chrome-1200x900-dpr-1.png b/diff/vaccination-apis-chrome-1200x900-dpr-1.png index dab1ced..39cb4f0 100644 Binary files a/diff/vaccination-apis-chrome-1200x900-dpr-1.png and b/diff/vaccination-apis-chrome-1200x900-dpr-1.png differ diff --git a/diff/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png b/diff/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png index a7501ff..f018a9b 100644 Binary files a/diff/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png and b/diff/vaccination-events-fhir-api-chrome-1200x900-dpr-1.png differ