<commit_before>---
title: Business requirements
keywords: requirements
tags: [appointments]
sidebar: appointments_sidebar
permalink: appointments_requirements.html
summary: "Clinical, user and governance requirements that must be supported by the solution"
---

The GP Connect requirements documentation for the Appointment Management Capability contains the set of business and solution requirements as defined in the API specifications and FHIR Structure Definitions. These are to be regarded as authoritative where difference, contradiction, or inaccuracy is identified in the requirements documentation.

The requirements and resulting API design have been developed in collaboration with NHS England, the GP Principal System Suppliers, clinical and GP Practice administrative stakeholders, FoT CCGs, and NHS Digital Urgent Care teams.

## User stories, API requirements & use cases ##
The business requirements are described as a set of high-level user stories with corrresponding functional specification requirements. System use case descriptions and activity diagrams detail how the Capability APIs are used for booking an appointment, or amending/cancelling an appointment.

## Physical data model ##
The physical data model identifies and defines the FHIR profile data items populated by Provider and/or Consumer as part of the Appointment Management APIs. 


## Requirements Documentation ##

This consists of:

- an Excel workbook containing NHS England source clinical scenarios, user stories, API specification requirements, high-level use case model, and physical data model

-   [GP Connect Requirements Document for Appointment Management](pages/appointments/businessrequirements/GP%20Connect%20Appointment%20Mgmt%20Capability%20Requirements%20-%20Developer%20Portal.xlsx){:target="_blank"} 

- Use case descriptions and activity diagrams in MS Word
- [GP Connect Appointment Management API Use Cases](pages/appointments/businessrequirements/GP%20Connect%20Appointment%20Mgmt%20API%20Use%20Cases.docx){:target="_blank"}
<commit_msg>AM: Bus Reqs Documentation Links<commit_after>---
title: Business requirements
keywords: requirements
tags: [appointments]
sidebar: appointments_sidebar
permalink: appointments_requirements.html
summary: "Clinical, user and governance requirements that must be supported by the solution"
---

The GP Connect requirements documentation for the Appointment Management Capability contains the set of business and solution requirements as defined in the API specifications and FHIR Structure Definitions. These are to be regarded as authoritative where difference, contradiction, or inaccuracy is identified in the requirements documentation.

The requirements and resulting API design have been developed in collaboration with NHS England, the GP Principal System Suppliers, clinical and GP Practice administrative stakeholders, FoT CCGs, and NHS Digital Urgent Care teams.

## User stories, API requirements & use cases ##
The business requirements are described as a set of high-level user stories with corrresponding functional specification requirements. System use case descriptions and activity diagrams detail how the Capability APIs are used for booking an appointment, or amending/cancelling an appointment.

## Physical data model ##
The physical data model identifies and defines the FHIR profile data items populated by Provider and/or Consumer as part of the Appointment Management APIs. 


## Requirements Documentation ##

This consists of:

- an Excel workbook containing NHS England source clinical scenarios, user stories, API specification requirements, high-level use case model, and physical data model

        -  [GP Connect Requirements Document for Appointment Management](pages/appointments/businessrequirements/GP%20Connect%20Appointment%20Mgmt%20Capability%20Requirements%20-%20Developer%20Portal.xlsx){:target="_blank"} 

- Use case descriptions and activity diagrams in MS Word
        - [GP Connect Appointment Management API Use Cases](pages/appointments/businessrequirements/GP%20Connect%20Appointment%20Mgmt%20API%20Use%20Cases.docx){:target="_blank"}

{'fraction_non_alphanumeric': 0.05058083252662149, 'fraction_numerical': 0.013552758954501452, 'mean_word_length': 6.0770547945205475, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1782037', 'n_tokens_mistral': 1011, 'n_tokens_neox': 900, 'n_words': 456}