Use this Endpoint to return data about a specific Service User record.
Use Case(s)
Use this endpoint if you wish to extract data about a specific service user N.B: If you pass the Practitioner ID then the Total Number of Stars Finalised returned will only be a count of stars from the Services that this Practitioner is assigned to.
Request body
ID (this is the Patient GUID) practitionerID – optional
Response body
ID Forename Surname PrimaryCareID ServiceUserID DateOfBirth ConsentGiven ConsentGivenByRepresentativeDetails PatientUrl DateCreated Total Stars Finalised MostRecentFinalisedStar
This endpoint can be used to update existing Service User records in SOL. *Please refer to section 2 of this document to understand the variance in mandatory fields for this endpoint, according to your configuration setup on OS Online.
Use Case(s)
If any edits to Service User records are made on the primary system to the data fields that are shared with SOL, then you can use this endpoint to send this updated data to SOL via the API. Note that you send all the fields related to the service user and they will all be updated in SOL. You should also use this Endpoint when you first start the integration to populate the Primary Care ID to existing Patient records in SOL.
Use this Endpoint to return a list of all Service Users
Use Case(s)
Use this endpoint if you wish import a large amount of data on all service users regarding their activity on SOL. If you pass the Practitioner ID then only Patients assigned to that Practitioner will be returned. Note that this Endpoint will return patients who have a “pending” status (i.e. they have been created using the POST Patients endpoint but have not yet had their Service assigned in SOL)
PageNumber PageSize TotalItems Items id (Patient GUID) Forename Surname PrimaryCareId Service User ID DateOfBirth Consent given ConsentGivenByRepresentativeDetails Patient URL DateCreated TotalStarsFinalised MostRecentFinalisedStar
Use this Endpoint to post a new Service User record from your primary system to the SOL. The API will then return the SOL record ID and URL to access the new record in SOL. Note that with this Endpoint it will still be necessary to assign the correct Service to the new Patient in SOL. If this Endpoint is triggered manually by the Practitioner in your Primary System, the Endpoint will return a URL which you can then use to code a redirect for the Practitioner to SOL where they will be directed to the correct screen to enable the Service Assignment to happen. If they do not do this then the record will be saved with a status of Pending in SOL and only the Account Lead OR the practitioner in question will be able to retrieve the record and assign the Services to the new Patient as required. If another user clicks the link in your primary system to view this Pending Service User record, they will be presented with a message telling them that they cannot access this record until a Service has been assigned. Please note that if Service User Consent is activated in your OS Online Configuration, then if consent given = false and whoGaveConsent is not selected, the API will not allow a new record to be created. See section 2 for details.
Use Case(s)
The practitioner has created a new Service User record in their Primary system and they want to quickly be able to create a corresponding record in SOL. Once the new record in the primary system has been saved, the practitioner can press a button in their primary system (or this could be setup as an automated event) which will then automatically trigger the creation of the record in SOL and the Endpoint response will provide a link which, if then added to the primary system record, will allow the user to navigate directly from the record in the Primary system to the corresponding Service User record in SOL. (Note that if Single Sign On is not implemented the user will have to login first and then be redirected to the Service User record) *Please refer to section 2 of this document to understand the variance in mandatory fields for this endpoint, according to your configuration setup on OS Online.
Use this Endpoint to post multiple new Service User records from your primary system to the SOL. The API will then return the new SOL record IDs and URLs to access the new records in SOL. Note that with this Endpoint it will still be necessary to assign the correct Service to the new Patient in SOL. The Account Lead or Practitioner in question will then need to login to SOL and deal with all these pending records and assign the Services to the new Patient records as required. Please note that if Service User Consent is activated in your OS Online Configuration, then if consent given = false and whoGaveConsent is not selected, the API will not allow a new record to be created. See section 2 for details.
Use Case(s)
The practitioners have created new Service User records in their Primary system and they want to quickly be able to create a corresponding record in SOL. The API can be coded to periodically collect data of all new records on the Primary system and by use of this endpoint it will then automatically trigger the creation of the record in SOL and the Endpoint response will provide a link which, if then added to the primary system record, will allow the user to navigate directly from the record in the Primary system to the corresponding Service User record in SOL. (Note that if Single Sign On is not implemented the user will have to login first and then be redirected to the Service User record) *Please refer to section 2 of this document to understand the variance in mandatory fields for this endpoint, according to your configuration setup on OS Online.
Use this Endpoint by sending details of a Service User in the request body for the API to then check for potential matches already created in SOL and to then return data about these matching records in the response. The logic for matching records as potential duplicates is the same as the duplicate check on the SOL interface: Partial match forename + partial match surname + DOB match OR Exact match forename + partial match surname + DOB match OR Partial match forename + exact match surname + DOB match OR PrimaryCareID matches an existing record exactly and exists within the account
Use Case(s)
When creating a new Service User record in the Primary software, before you use the POST Patient Endpoint to create a new records in SOL you may first wish to check for potential duplicate records. The API will then search the SOL database and return the following data for any potential matches: You can then display this data to the end user within the primary software and they can choose to either select one of the matching records and link that to their record in the Primary software OR they can create a new record using POST Patient.
This endpoint can be used to return the Patients Extract of data in excel format- this is the same extract that is also available via the SOL admin interface. The endpoint can optionally return fully anonymised data if preferred. Different data is held on different sheets of the XLS – so you can use the Request body to select the sheets that you wish to have returned. You can also define the filename of the download in the Request body.
Use Case(s)
If you wish for your system to automatically retrieve the Full Data Extract for use in your reporting / BI system then you can use this endpoint to obtain the extract for retrieval from a location on the SOL server.
This endpoint can be used to return the Patients Extract of data in JSON format- this is the same extract that is also available via the SOL admin interface. The endpoint can optionally return fully anonymised data if preferred. Different data is held on different sheets of the XLS – so you can use the Request body to select the sheets that you wish to have returned. You can also define the filename of the download in the Request body.
Use Case(s)
If you wish for your system to automatically retrieve the Full Data Extract for use in your reporting / BI system then you can use this endpoint to obtain the extract for retrieval from a location on the SOL server.
This endpoint can be used to return the Patients Extract of data in CSV format- this is the same extract that is also available via the SOL admin interface. The endpoint can optionally return fully anonymised data if preferred. Different data is held on different CSV files – so you can use the Request body to select the files that you wish to have populated with data as well as the filename of the zip file. Note that all 8 CSV files will always be returned in the zip file, they just may not all be populated according to your Request.
Use Case(s)
If you wish for your system to automatically retrieve the Full Data Extract for use in your reporting / BI system then you can use this endpoint to obtain the extract for retrieval from a location on the SOL server.
POST /api/patients-extract/service-and-star-excel #
Endpoint Name
POST /api/patients-extract/service-and-star-excel
Description
This endpoint can be used to return the Patients Extract of Service and Star data that is also available via the SOL admin interface as an Excel download. The endpoint can optionally return fully anonymised data if preferred. You can use the Request body to define which sheets of data you wish to have returned and also the filename of the download. Please note that the Primary Care ID from your case management software will also be returned in this extract – if it has been added to a record via the API.
Use Case(s)
If you wish for your system to automatically retrieve the Service User Data Extract of services and stars for use in your reporting / BI system, then you can use this endpoint to obtain the extract for retrieval from a location on the SOL server.
POST /api/patients-extract/service-and-star-json #
Endpoint Name
POST /api/patients-extract/service-and-star-json
Description
This endpoint can be used to return a JSON object of the Patients Extract of Service and Star data that is also available via the SOL admin interface as an Excel download. The endpoint can optionally return fully anonymised data if preferred. You can use the Request body to define which sheets of data you wish to have returned and also the filename of the download. Please note that the Primary Care ID from your case management software will also be returned in this extract – if it has been added to a record via the API.
Use Case(s)
If you wish for your system to automatically retrieve the Service User Data Extract of services and stars for use in your reporting / BI system, then you can use this endpoint to obtain the extract for retrieval from a location on the SOL server.
This endpoint can be used to return the Patients Extract of Service and Star data that is also available via the SOL admin interface as a zip file of CSV files. The endpoint can optionally return fully anonymised data if preferred. You can use the Request body to define which CSV files you wish to have populated and also the filename of the download. Note that all 8 CSV files will always be returned in the zip file, they just may not all be populated according to your Request.
Use Case(s)
If you wish for your system to automatically retrieve the Service User Data Extract of services and stars for use in your reporting / BI system, then you can use this endpoint to obtain the extract for retrieval from a location on the SOL server.
There are 2 endpoints that use the FHIR (Fast Healthcare Interoperability Resources) specification to define the different data items sent to and from SOL. The mapping of the data items is as per the R4B data format, detailed as follows:
Use this Endpoint to return data about a specific Service User record in the FHIR R4B format.
Use Case(s)
Use this endpoint if you wish to extract data about a specific service user If you pass the Practitioner ID then the Total Number of Stars returned will only be a count of stars from the Services that this Practitioner is assigned to.
Request body
SOL Patient ID (Guid) Practitioner ID (Guid) – optional
Response body
PatientId (Guid) Forename (string) Surname (string) Service User ID DateOfBirth (YYYY-MM-DD)
Use this Endpoint to post a new Service User record from your primary system to the SOL using the FHIR R4B format. The API will then return the SOL record ID and URL to access the new record in SOL. Note that the parameters of: Practitioner ID Consent Given ConsentGivenByRepresentativeDetails Are requested as well as the Response body as they are not within the FHIR format. Note that with this Endpoint it will still be necessary to assign the correct Service to the new Patient in SOL. If this Endpoint is triggered manually by the Practitioner in your Primary System, the Endpoint will return a URL which you can then use to code a redirect for the Practitioner to SOL where they will be directed to the correct screen to enable the Service Assigment to happen. If they do not do this then the record will be saved with a status of Pending in SOL and only the Account Lead OR the practitioner in question will be able to retrieve the record and assign the Services to the new Patient as required.
Use Case(s)
The practitioner has created a new Service User record in their Primary system and they want to quickly be able to create a corresponding record in SOL. Once the new record in the primary system has been saved, the practitioner can press a button in their primary system (or this could be setup as an automated event) which will then automatically trigger the creation of the record in SOL and the Endpoint response will provide a link which, if then added to the primary system record, will allow the user to navigate directly from the record in the Primary system to the corresponding Service User record in SOL. (Note that if Single Sign On is not implemented the user will have to login first and then be redirected to the Service User record)
Use this endpoint to receive the URL for accessing the latest completed star PDF’s for a specific Service User. Once this endpoint has been used to get the URL you can then use the GET patients/{id}/star-summary-download endpoint to download the actual PDF.
Use Case(s)
To receive the latest Star PDF’s for a specific Service User send the patient ID in the request body. Receive the PDF’s for download from the SOL servers.
Use this endpoint to receive the URL for accessing ALL completed star PDF’s for a specific Service User. Once this endpoint has been used to get the URL you can then use the GET patients/{id}/star-summary-download endpoint to download the actual PDF.
Use Case(s)
To receive all the completed Star PDF’s for a specific Service User send the patient ID in the request body. Receive the URL for download of PDF’s.
Use this endpoint after using the Patients/{id}latest-stars endpoint to obtain the Star ID. Use the Star ID in the request of this endpoint to obtain the URL from where the PDF file(s) can be downloaded. Note that the Star ID is included within the URL that is returned from: GET patients/{id}/all-starsGET patients{id}/latest-stars
Use Case(s)
To receive all the completed Star PDF’s for a specific Service User send the patient ID and Star ID in the request body. Receive the URL for download of PDF’s.
Use this endpoint to return details of a specific Practitioner
Use Case(s)
This endpoint can be used to obtain details about the Practitioner and a URL for the login screen on SOL with the Practitioner email address pre-populated which can be of use if you wish to add a shortcut to SOL from your case management system. Note that if you are using Single Sign On (SSO) with SOL then if your practitioner is shown a link to click in your primary system to view SOL then using the URL returned in this endpoint will enable them to login automatically.
Use this endpoint to return details of all the Practitioners saved in your account on SOL.
Use Case(s)
This endpoint is one that you will need to use as part of the intial setup process for the API to obtain the StarOnlineID for each of your Practitioners as you will need to save this data item in your primary case management system against a practitioner record so you can then use some of the other endpoints in the SOL.
