FHIR Get Structured Record API - Revision history

JoshuA at 13:05, 2 July 2021

2021-07-02T13:05:07Z

← Older revision		Revision as of 13:05, 2 July 2021
Line 39:		Line 39:
	</syntaxhighlight>The <code>grantType</code> parameter must be set to <code>client_credentials</code>.		</syntaxhighlight>The <code>grantType</code> parameter must be set to <code>client_credentials</code>.

	Use 6d8e1310-5e9c-4b62-b314-79fbd9c735d5 as the client secret for demo purposes only; the client secret is unique to each client application and can be acquired by contacting the ~~Learning Health Solutions~~ Helpdesk at ~~https://learning-health.co.uk/~~.		Use 6d8e1310-5e9c-4b62-b314-79fbd9c735d5 as the client secret for demo purposes only; the client secret is unique to each client application and can be acquired by contacting the Discovery Data Service Helpdesk at info@discoverydataservice.org



	If the access token request is valid and authorized, the authorization server issues an access token in this JSON reply, or a 404 HTTP Not Found (Unauthorized Client) response if the request failed client authentication or is invalid.<syntaxhighlight lang="json">		If the access token request is valid and authorized, the authorization server issues an access token in this JSON reply, or a 404 HTTP Not Found (Unauthorized Client) response if the request failed client authentication or is invalid.<syntaxhighlight lang="json">
Line 151:		Line 153:
	</syntaxhighlight>		</syntaxhighlight>

	~~The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk~~/		<br />

JoC: /* Date of Birth */

2021-01-27T15:46:43Z

Date of Birth

← Older revision		Revision as of 15:46, 27 January 2021
Line 114:		Line 114:
	The message body of the getRecord request can contain a number of optional parameters that change the behaviour of the API:		The message body of the getRecord request can contain a number of optional parameters that change the behaviour of the API:

	=== Date of ~~Birth~~ ===		=== Date of birth ===
	In addition to supplying an NHS number, you can optionally include the patient's date of birth by including the following parameter:<syntaxhighlight lang="json">		In addition to supplying an NHS number, you can optionally include the patient's date of birth by including the following parameter:<syntaxhighlight lang="json">
	{		{

JoC: /* Demographics Only */

2021-01-27T15:46:19Z

Demographics Only

← Older revision		Revision as of 15:46, 27 January 2021
Line 125:		Line 125:
	</syntaxhighlight>We encourage the use of this parameter to provide additional assurance that the correct patient is being requested and returned; if the NHS number and date of birth do not match with a record in the DDS, no record will be returned.		</syntaxhighlight>We encourage the use of this parameter to provide additional assurance that the correct patient is being requested and returned; if the NHS number and date of birth do not match with a record in the DDS, no record will be returned.

	=== Demographics ~~Only~~ ===		=== Demographics only ===
	You can restrict the data returned to only include patient demographic information instead of the full medical record; this can be requested by using the following parameter:<syntaxhighlight lang="json">		You can restrict the data returned to only include patient demographic information instead of the full medical record; this can be requested by using the following parameter:<syntaxhighlight lang="json">
	{		{
Line 138:		Line 138:
	</syntaxhighlight>		</syntaxhighlight>

	=== Include ~~Inactive Patients~~ ===		=== Include inactive patients ===
	By default the API will only return fully active and registered patients who are not marked as deceased. If your project requires access to inactive or deceased patients, and to include those patients in the results, the following parameter can be used:<syntaxhighlight lang="json">		By default the API will only return fully active and registered patients who are not marked as deceased. If your project requires access to inactive or deceased patients, and to include those patients in the results, the following parameter can be used:<syntaxhighlight lang="json">
	{		{

JoC: /* Optional Request Parameters */

2021-01-27T15:45:43Z

Optional Request Parameters

← Older revision		Revision as of 15:45, 27 January 2021
Line 111:		Line 111:
	<br />		<br />

	== Optional ~~Request Parameters~~ ==		== Optional request parameters ==
	The message body of the getRecord request can contain a number of optional parameters ~~which will~~ change the behaviour of the API.		The message body of the getRecord request can contain a number of optional parameters that change the behaviour of the API:

	=== Date of Birth ===		=== Date of Birth ===
	In addition to supplying an NHS number, you can optionally include the patient's date of birth by including the following parameter. We encourage the use of this parameter to provide additional assurance that the correct patient is being requested and returned. If the NHS number and date of birth do not match with a record in the DDS then no record will be returned.<syntaxhighlight lang="json">		In addition to supplying an NHS number, you can optionally include the patient's date of birth by including the following parameter:<syntaxhighlight lang="json">
	{		{
	"name": "patientDOB",		"name": "patientDOB",
Line 123:		Line 123:
	}		}
	}		}
	</syntaxhighlight>		</syntaxhighlight>We encourage the use of this parameter to provide additional assurance that the correct patient is being requested and returned; if the NHS number and date of birth do not match with a record in the DDS, no record will be returned.

	=== Demographics Only ===		=== Demographics Only ===
	~~An optional parameter is available to~~ restrict the data returned to only include patient demographic information instead of the full medical record~~. This~~ can be requested by using the following parameter.<syntaxhighlight lang="json">		You can restrict the data returned to only include patient demographic information instead of the full medical record; this can be requested by using the following parameter:<syntaxhighlight lang="json">
	{		{
	"name": "demographicsOnly",		"name": "demographicsOnly",
Line 139:		Line 139:

	=== Include Inactive Patients ===		=== Include Inactive Patients ===
	By default the API will only return fully active, registered patients who are not marked as deceased. If your project requires access to inactive or deceased patients ~~then~~ the following parameter can be used ~~to include these patients in the results.~~<syntaxhighlight lang="json">		By default the API will only return fully active and registered patients who are not marked as deceased. If your project requires access to inactive or deceased patients, and to include those patients in the results, the following parameter can be used:<syntaxhighlight lang="json">
	{		{
	"name": "includeInactivePatients",		"name": "includeInactivePatients",

Stuart KD: Include information about optional parameters on the get structured record API page

2021-01-27T15:29:07Z

Include information about optional parameters on the get structured record API page

← Older revision		Revision as of 15:29, 27 January 2021
Line 109:		Line 109:
	[[File:Workflow.png\|600x600px]]		[[File:Workflow.png\|600x600px]]

			<br />

			== Optional Request Parameters ==
			The message body of the getRecord request can contain a number of optional parameters which will change the behaviour of the API.

			=== Date of Birth ===
			In addition to supplying an NHS number, you can optionally include the patient's date of birth by including the following parameter. We encourage the use of this parameter to provide additional assurance that the correct patient is being requested and returned. If the NHS number and date of birth do not match with a record in the DDS then no record will be returned.<syntaxhighlight lang="json">
			{
			"name": "patientDOB",
			"valueIdentifier": {
			"system": "https://fhir.hl7.org.uk/Id/dob",
			"value": "1970-01-01"
			}
			}
			</syntaxhighlight>

			=== Demographics Only ===
			An optional parameter is available to restrict the data returned to only include patient demographic information instead of the full medical record. This can be requested by using the following parameter.<syntaxhighlight lang="json">
			{
			"name": "demographicsOnly",
			"part": [
			{
			"name": "includeDemographicsOnly",
			"valueBoolean": true
			}
			]
			}
			</syntaxhighlight>

			=== Include Inactive Patients ===
			By default the API will only return fully active, registered patients who are not marked as deceased. If your project requires access to inactive or deceased patients then the following parameter can be used to include these patients in the results.<syntaxhighlight lang="json">
			{
			"name": "includeInactivePatients",
			"part": [
			{
			"name": "includeInactivePatients",
			"valueBoolean": true
			}
			]
			}
			</syntaxhighlight>

	The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk/		The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk/

Stuart KD at 12:09, 8 December 2020

2020-12-08T12:09:56Z

← Older revision		Revision as of 12:09, 8 December 2020
Line 60:		Line 60:
	This call uses the access token from the authentication API to authorise the client's access to the API, which will return the FHIR bundle if the client is recognised and authorised to use this service.		This call uses the access token from the authentication API to authorise the client's access to the API, which will return the FHIR bundle if the client is recognised and authorised to use this service.

	https://~~devfhir~~.discoverydataservice.net/patient/$getstructuredrecord		https://devfhirapi.discoverydataservice.net:8443/fhirTestAPI/patient/$getstructuredrecord



	Passing this JSON POST body<syntaxhighlight lang="json">		Passing this JSON POST body<syntaxhighlight lang="json">

JoC: /* Authorise/GetRecord */

2020-08-27T12:13:26Z

Authorise/GetRecord

← Older revision		Revision as of 12:13, 27 August 2020
Line 101:		Line 101:

	Success will return the FHIR bundle for the patient specified in the query parameters.		Success will return the FHIR bundle for the patient specified in the query parameters.

			A list of NHS numbers that can be used in this Authorise/GetRecord paramaeter can be found [[Dummy NHS numbers\|here]].

	=== Workflow ===		=== Workflow ===

JoC at 13:35, 18 August 2020

2020-08-18T13:35:14Z

← Older revision		Revision as of 13:35, 18 August 2020
Line 39:		Line 39:
	</syntaxhighlight>The <code>grantType</code> parameter must be set to <code>client_credentials</code>.		</syntaxhighlight>The <code>grantType</code> parameter must be set to <code>client_credentials</code>.

	(the client secret is unique to each client application and can be acquired by contacting the Learning Health Solutions Helpdesk at https://learning-health.co.uk/)		Use 6d8e1310-5e9c-4b62-b314-79fbd9c735d5 as the client secret for demo purposes only; the client secret is unique to each client application and can be acquired by contacting the Learning Health Solutions Helpdesk at https://learning-health.co.uk/.

	If the access token request is valid and authorized, the authorization server issues an access token in this JSON reply, or a 404 HTTP Not Found (Unauthorized Client) response if the request failed client authentication or is invalid.<syntaxhighlight lang="json">		If the access token request is valid and authorized, the authorization server issues an access token in this JSON reply, or a 404 HTTP Not Found (Unauthorized Client) response if the request failed client authentication or is invalid.<syntaxhighlight lang="json">

JoC at 14:28, 15 June 2020

2020-06-15T14:28:42Z

← Older revision		Revision as of 14:28, 15 June 2020
Line 102:		Line 102:
	Success will return the FHIR bundle for the patient specified in the query parameters.		Success will return the FHIR bundle for the patient specified in the query parameters.

	== Workflow ==		=== Workflow ===
	[[File:Workflow.png\|600x600px]]		[[File:Workflow.png\|600x600px]]


	The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk/		The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk/

JoC at 14:27, 15 June 2020

2020-06-15T14:27:46Z

← Older revision		Revision as of 14:27, 15 June 2020
Line 22:		Line 22:
	* Authorise/GetRecord		* Authorise/GetRecord

	=== Authenticate ===		== Authenticate ==
	Authenticate the client identity by passing in client credentials to receive an access token for the API.		Authenticate the client identity by passing in client credentials to receive an access token for the API.

Line 55:		Line 55:

	https://tools.ietf.org/html/rfc6749#section-4.4		https://tools.ietf.org/html/rfc6749#section-4.4
	=== Authorise/GetRecord ===		== Authorise/GetRecord ==
	Retrieve a patient's structured care record as a FHIR bundle in the FHIR CareConnect STU3 format. See https://fhir.hl7.org.uk/		Retrieve a patient's structured care record as a FHIR bundle in the FHIR CareConnect STU3 format. See https://fhir.hl7.org.uk/

Line 102:		Line 102:
	Success will return the FHIR bundle for the patient specified in the query parameters.		Success will return the FHIR bundle for the patient specified in the query parameters.

	=== Workflow ===		== Workflow ==
	[[File:Workflow.png\|600x600px]]		[[File:Workflow.png\|600x600px]]


	The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk/		The Discovery Data Service is powered by Learning Health Solutions Ltd. https://learning-health.co.uk/