PROMs - Event Request
Request that a patient be sent an assessment questionnaire after clinical events
Request that a patient be sent an assessment questionnaire after clinical events
This is the standard API used to trigger PROMs capture by the National PROMs platform (https://proms.nhs.wales)
The API is used by patient administration systems to request that questionnaires be sent to patients at relevant stages along a treatment pathway.
It is available nationally and currently used in almost all Health Boards.
SOAP/XML
SOAP/XML
WCCG - Clinical Documents Exchange
Send and receive clinical documents such as referral letters
Send and receive clinical documents such as referral letters
The API is allows registered users and applications to exchange clinical documents.
It is used by GP Systems and WCCIS to exchange documents such as electronic referrals with secondary care applications.
It is available nationally.
SOAP/XML
SOAP/XML
WGPR - GP Record Retrieval
Retrieve a patient's clinical record as held on GP Systems
Retrieve a patient's clinical record as held on GP Systems
The API provides access to the patient data held on GP Systems, e.g. medications, problems and diagnoses, test results etc.
It is used by the Welsh Clinical Portal and Choose Pharmacy to retrieve the currently prescribed medications for a patient.
It is available nationally across primary and secondary care.
SOAP/XML
SOAP/XML
WAMS - Address Matching
Search for addresses in the nationally approved address list
Search for addresses in the nationally approved address list
The API allows searching and matching against the Welsh Address Matching Service (WAMS).
Both a SOAP and equivalent Web RPC style API are available.
Applications use this API to provide users with address searching and to standardise manually entered addresses to be consistent with other systems.
It is available nationally.
SOAP/XML or RPC/JSON
SOAP/XML or RPC/JSON
WCRS - FHIR Documents
Store patient documents
Store patient documents
This API could be used to store documents in the Welsh Care Records Service (WCRS), using the FHIR DocumentReference resource
It should be considered experimental. Anybody can try out the demo/sandbox implementation and provide feedback.
It is currently only available in the sandbox environment and not in production.
FHIR/REST
FHIR/REST
WCRS - Documents
Store and retrieve patient documents and perform basic searches
Store and retrieve patient documents and perform basic searches
This API is used to store documents in the Welsh Care Records Service (WCRS), the central patient document store for NHS Wales.
You can use it to store/retrieve patient documents in a variety of formats (e.g. XML, PDF, Microsoft Word) with relevant metadata.
Using the search functionality you can query for a document by its metadata.
This API is used make clinical documents such as Discharge Advice Letters, Care Plans, Referrals etc. accessible by other systems.
It is available nationally and used in all Health Boards.
SOAP/XML
SOAP/XML
WCRS - Documents Advanced Search
Perform faceted search queries against the content and metadata of patient documents
Perform faceted search queries against the content and metadata of patient documents
We use Apache Solr to prvoide advanced search against patient documents in the Welsh Care Record Service.
You can perform general searches across all document content as well as metadata, for which a standard set of fields is defined for all documents.
Faceted search allows you to group and filter results by category until you find the document your looking for.
The advanced search features are primarily used by the Welsh Clinical Portal to allow users to browse for relevant patient documents.
It is available nationally and used in all Health Boards.
Solr
Solr
WRDS - Reference Data Drip-Feed API
Read and sync bulk data by date by registering for specific data-sets in advance.
Read and sync bulk data by date by registering for specific data-sets in advance.
This API allows registered users to query for changes to their pre-specified sets of reference data and retrieve full or partial changes in bulk.
It is used by systems to efficiently cache reference data that would otherwise need to be fetched via the other lookup APIs.
It is available nationally.
SOAP/XML
SOAP/XML
WRDS - FHIR Terminology
Look up codes from clinical classifications and ontologies
Look up codes from clinical classifications and ontologies
This API could be used to search for clinical ontology codes like SNOMED CT using FHIR Resources
It should be considered experimental. Anybody can try out the demo/sandbox implementation and provide feedback.
It is available in the sandbox environment and being tested internally for production use.
FHIR/REST
FHIR/REST
WRDS - FHIR Reference Data
Retrieve organisational reference data
Retrieve organisational reference data
This API could be used to retrieve lists of practitioners, GP practices, hospitals etc., using the FHIR Organization, Practitioner and PractitionerRole resources.
It should be considered experimental. Anybody can try out the demo/sandbox implementation and provide feedback.
It is currently only available in the sandbox environment and not in production.
FHIR/REST
FHIR/REST
WRDS - Reference Data & Schema Lookup
Retrieves table schemas and data listing all fields in the database.
Retrieves table schemas and data listing all fields in the database.
A RESTful service providing similar functionality to the standard lookup API for retrieving reference data from WRDS.
Additionally with this API you can retrieve the table schema to build POCO objects for deserialising the responses.
This is available nationally.
RESTful
RESTful
WRDS - Reference Data Standard Lookup
Retrieve specific fields from reference sets.
Retrieve specific fields from reference sets.
A SOAP service supporting ad-hoc enquiries against WRDS, the store of nationally agreed reference data.
It is used by applications to retrieve data such as location codes for GP Practices, hospitals, pharmacies, lists of available drugs, pathology tests etc.
This API is suitable for production use and is available nationally.
SOAP/XML
SOAP/XML
AC3 - Account Control
Authenticate and authorise users
Authenticate and authorise users
The API provides access to the AC3 identity provider.
Applications use this to authenticate users as well as manage and check their access rights.
It is available nationally across primary and secondary care.
SOAP/XML
SOAP/XML
CAS - Audit Logging
Write user activity to a central audit log
Write user activity to a central audit log
The API allows you to write pre-defined audit events for AC3 users to the Central Audit Service (CAS).
Applications use this to be compliant with audit requirements and make audit logs available to other
systems such as the National Intelligent Integrated Auditing Solutions (NIIAS).
It is available nationally.
SOAP/XML
SOAP/XML
MPI - FHIR Patient
Query for patients identifiers matched across multiple systems
Query for patients identifiers matched across multiple systems
This API could be used to query the Master Patient Index using the FHIR Patient resource.
It should be considered experimental. Anybody can try out the demo/sandbox implementation and provide feedback.
It is currently only available in the sandbox environment and not in production.
FHIR/REST
FHIR/REST
MPI - Master Patient Index
Query for patients identifiers matched across multiple systems
Query for patients identifiers matched across multiple systems
These APIs implement the PIX and PDQ Integration Profiles from IHE.
You can use Patient Identifier Cross Referencing (PIX) to match patients records across multiple systems.
You can perform Patient Demographic Queries (PDQ) to search for patients demographic information, such as address or date of birth.
The APIs are used by applications such as the Welsh Clinical Portal to retrieve all local identifiers for a patient, which then enables
it retrieve and combine local records, such as test results, into a single list.
It is available nationally and used across primary and secondary care in all health boards.
SOAP/XML + HL7v2.5
SOAP/XML + HL7v2.5
WBNS - Birth Notifications
Register births and receive an NHS Number
Register births and receive an NHS Number
This API accepts HL7 ADT messages with details of a birth (mother's details, time of birth, gender, birth weight etc.) and responds with a newly generated NHS Number.
It is used by maternity systems to notify downstream systems of births and obtain NHS Numbers for newborns.
It is available nationally.
SOAP/XML + HL7 v2.3, v3
SOAP/XML + HL7 v2.3, v3
WRRS - FHIR Diagnostics
Retrieve patient test results for pathology and radiology
Retrieve patient test results for pathology and radiology
This API could allow search/retrieval of a patients test results using the FHIR DiagnosticReport and Observation resources.
It should be considered experimental. Anybody can try out the demo/sandbox implementation and provide feedback.
It is currently only available in the sandbox environment and not in production.
FHIR/REST
FHIR/REST
WRRS - Result Requesting & Reporting
Request radiology scans and pathology tests on specimens like blood samples.
Request radiology scans and pathology tests on specimens like blood samples.
This service mediates requests to Laboratory and Radiology Management Systems and returns request IDs
so that specimens can be labelled and subsequently identified when received by laboratories.
The API also allows search/retrieval of a patients previous test requests and results.
Applications use it to allow users in hospitals and GP surgeries to request diagnostic tests, generate
barcode labels for the specimen containers and display results as either a detailed list or chart and table.
It is available nationally in primary and secondary care.
SOAP/XML
SOAP/XML
WDS - Patient Demographics
Search for patient demographic information such as Address, Date of Birth, NHS Number etc.
Search for patient demographic information such as Address, Date of Birth, NHS Number etc.
This API provides access to the Welsh Demographics Service.
You can search for a patient by NHS Number or information such as name and date of birth and a
standard exists for synchronising this data with a systems locally stored patient record.
It is used by applications to keep patient information accurate and up-to-date.
It is available nationally and used across primary and secondary care in all health boards.
SOAP/XML
SOAP/XML