Background
FGM IS is currently view only (v1.0). Suppliers are required to move to FGM IS v2.0
FGM IS v2.0 is for all suppliers to develop query, create and delete with an uplift to the query requirements to support local caching.
The FGM IS Interoperability has been through two iterations
- FGM IS v1.0 - this is currently supported in live use for phase 1 query with an agreed supplier set ONLY. This specification is deprecated for further development. Further information about this standard can be found on NHS Digital FGM IS landing page and here: https://data.developer.nhs.uk/fhir/fgm/Chapter.1.About/index.html
- FGM IS v2.0 - this is now supported for all suppliers to develop query, create and delete with an uplift to the query requirements to support local caching. Information can be found here https://developer.nhs.uk/apis/fgm-v2/
The FGM IS requirements should not be confused with the FGM Enhanced Datasetthat requires organisations to record, collect and return detailed information about individual Patients affected by FGM.
For more information on this dataset see http://content.digital.nhs.uk/isce/publication/scci2026.
Outline Plan
Suppliers on v1.0 will need to move over to v2.0 of FGM IS API
Summary of Change
Suppliers need to adhere to v2.0 of the FGM standard as it allows for view, create and delete whereas v1.0 is view only, more information can be found here: FGM IS API version 2.0
FGM Update Capability
An ‘update’ capability within local NHS systems. Enabling additional create and delete capability for local NHS systems integration to the FGM IS.
This functionality is only applicable to local NHS IT systems that are Spine compliant and use National Role Based Access Control (RBAC). The FGM IS can only be updated by authorised healthcare professionals using Smartcards with the correct RBAC activity codes.
Create Patient FGM flag
The FGM client will construct a FHIR create FGM flag message and send it to the SPINE. Assuming successful transport, there are two possible outcomes:
- SPINE rejects the create flag request due to business rules around the message construct
- SPINE executes the create flag request and there is an FGM risk entry created for the Patient on Spine
Delete Patient FGM flag
The FGM client will construct a FHIR delete FGM flag request message and send it to the SPINE. Assuming successful transport, there are two possible outcomes:
- SPINE rejects the delete flag request due to business rules around the message construct
- SPINE executes the delete flag request and the FGM risk entry is deleted for the Patient on Spine
Full Specification
The API Hub on the NHS Developer Network contains the latest documentation for FGM IS API v2.0.
The latest Requirements Specification document is version 2.1 and is downloadable from this page in the above site. (The embedded documents have been versioned independently of the API specification)
SCCI2112 - FGM IS Local System Integration Information Standard contains information about the Information Standards Notice.
Note: the documents downloadable in the Releases section apply to FGM IS v1.0 only.
Assurance Approach
Assurance will be via a Risk Based Approach (RBA). RBA is an assurance process which involves reviewing Risks involved in connecting to the service and providing mitigation details.
Compliance is established through the risk mitigations, completion of the Supplier Conformance Assessment List and by signing the Connection Agreement.
For advice and support from the NHS Business Partners programme, please contact businesspartners@nhs.net or visit https://digital.nhs.uk/services/nhs-business-partners