SMS Developer cheat sheet shortcuts for the technical build of SMS clients accessing the web service APIs.
SMS cheat sheet
Shortcuts
Explore
Three functional requirements are included in the requirements pack:
- PDS Message Specifications within the ‘PDSMiniServices.zip’
- SMS Functional Requirements – Foundation in the ‘ITK Spine Mini Service – Common Client Requirements-v1.0.pdf’
- SMS Functional Requirements – Demographics in the ‘PDS – Spine Mini Service Client Requirements-v1.0.pdf’
Build
- Java Reference Implementation – see below
- .NET Classes for ITK SOAP Services
Test
SMS developer requirements
As described in the NHS Digital compliance process, if a supplier does not already have a conformant product (client), technical conformance approval must be obtained. This begins with developing the client in line with the necessary requirements (including specifications) and policies.
The main resource for development is the downloadable requirements pack, containing functional requirements, policies and guidance relevant to the technical build of SMS clients accessing the web service APIs .
A blank TOM is included in the requirements pack but if a TOM has already been populated during the phase 1a usage and settings approval process, a new TOM should not be created; the information required for phase 1b technical conformance approval will simply be added to the Phase 1a information. Read the further guidance.
SMSP Reference Implementation (Java)
The ITK API provides a Java abstraction to the ITK transport and distribution mechanics. As such it aims to simplify the task of exchanging ITK based messages between applications whilst maintaining all of the benefits that the ITK “on the wire” specifications bring.
The following reference implementation (a client accessing Spine Mini Services for PDS) provides a set of examples scenarios that show how the API can be realised and used in real world uses. One such reference implementation is a client accessing spine mini services for demographics.
Learn more about the interoperability framework.
You can try it.
Artifacts that are direct products of the ITK, API and reference implementation project.
Related pages
-
external
TK reference implementation
Learn more about the ITK APIs.
-
external
Reference Implementation Project
Download artefacts that are direct products of the ITK, API and reference implementation project.
-
internal Stage 2: Access to Personal Demographics Service
Describes the required approval of usage and settings mainly relating to the end user.
-
internal Stage 4: test and assurance
Provides information about how to complete the test and assurance process.
-
internal Spine Mini Service Provider for Personal Demographics Service
The NHS Digital Spine Mini Service Provider (SMSP) lets health and social care providers access important information held on Spine. It aims to reduce the complexities around integration with the Spine.
-
internal Requirements pack and TOM template
Essential specifications and guidance for developing a compliant client product.
Last edited: 8 May 2019 8:41 am