Skip to main content
Summary Care Record - FHIR API

Access patient's Summary Care Record (SCR), an electronic record of important patient information, using our FHIR API.

Overview

Use this API to access a patient's Summary Care Record (SCR) - an electronic record of important patient information, created from GP medical records. SCRs can be seen and used by authorised staff in other areas of the health and care system involved in the patient's direct care.

Also use this API to access the Access Control Service (ACS) - which manages consent to share information for SCR.

You can:

  • create a patient's Summary Care Record
  • retrieve a patient's Summary Care Record
  • set consent to share information
  • raise information governance alerts in certain circumstances when viewing a patient's Summary Care Record

Who can use this API

This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must do this before you can go live (see ‘Onboarding’ below).


To use this API, you will need the patient's NHS number, which can be retrieved by using the following API:

  • Personal Demographics Service (FHIR) API - use this API to search for patients and retrieve their details. This API can also be used to update their details in some cases. This is the latest version of the PDS API and is recommended for all new integrators.

API status and roadmap

This API is initially for use by new market entrant GP IT developers with other use cases to follow later.

This API is in alpha, meaning:

  • the API is available in our sandbox and integration test environments
  • the API is not yet available for production use
  • we might make breaking changes, but only if we cannot avoid it, and we'll give advance notice

To see our roadmap, or to suggest, comment or vote on features for this API, see our interactive product backlog.

If you have any other queries, please contact us.


Technology

This API is RESTful.

It also conforms to the FHIR (R4) global standard for health care data exchange.

You don’t need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules. In particular: - array names are singular, for example line not lines for address lines - data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an extension object


Network Access

This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN). To use this API with NHS smartcards (see below) you do need an HSCN connection, although internet-facing alternatives are available.

For more details see Network access for APIs.


Authorisation

This API is user-restricted, meaning an end user must be present and authenticated to use it.

The end user must be:

The API uses OAuth 2.0 to authorise the calling system. It supports the following security patterns:

For more details, see user-restricted APIs.


Environments and testing

Purpose Base URL
Sandbox https://sandbox.api.service.nhs.uk/summary-care-record/FHIR/R4
Integration test https://int.api.service.nhs.uk/summary-care-record/FHIR/R4

Sandbox testing

Our sandbox environment:

  • is for early developer testing
  • only covers a limited set of scenarios
  • is stateless, so it does not actually persist any updates
  • is open access, so does not allow you to test authorisation

For more details on sandbox testing, or to try out the sandbox using our "Try this API" feature, see the documentation for each endpoint.

Integration testing

Our integration test environment:

  • is for formal integration testing
  • is stateful, so persists updates
  • includes authorisation, with smartcard and non-smartcard options

For more details see integration testing with our RESTful APIs.


Onboarding

You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.


Endpoints

Update patient's consent to share SCR

post
/$setPermission

Overview

Use this endpoint to update the Permission to share the GP Summaries

Sandbox test scenarios

You can test the following scenarios in our sandbox environment:

Scenario Request Response
Happy path NHSD-Session-URID=555254240100; nhsNumber=9995000180 HTTP Status 201
Patient not found NHSD-Session-URID=555254240100; nhsNumber=9693042298 HTTP Status 400

Request

Headers
Name Description
Authorization

String (^Bearer\ [[:ascii:]]+$)

An OAuth 2.0 bearer token. Required in all environments except sandbox.

Example: Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM

Required
X-Correlation-ID

String

A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.

Mirrored back in a response header.

Avoid . characters.

Example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

X-Request-ID

String

A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.

Must be a universally unique identifier (UUID) (ideally version 4). If you re-send a failed request, use the same value in this header. Mirrored back in a response header.

Pattern: /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

Example: 60E0B220-8136-4CA5-AE46-1D97EF59D068

NHSD-Session-URID

String

The user role ID (URID) for the current session. Also known as a user role profile ID (URPID).

If you are using User-restricted RESTful APIs - NHS login combined authentication and authorisation, See determin the user's role guidance. If you are using User-restricted RESTful APIs - NHS login separate authentication and authorisation, See determin the user's role guidance.

This field is optional.

Pattern: /^[0-9]+$/

Example: 555021935107

Content-Type

String

Used to indicate what type of data is actually sent

Example: application/fhir+json

Required
Body
Required

Content type: application/fhir+json

Example

Schema

Name Description
object
resourceType
string
required
Default: Parameters
parameter
array
required
Max items: 1
Min items: 1
object
name
string
required
Default: setPermissions
part
array
required
Max items: 2
Min items: 2
anyOf
object
name
string
required
Default: nhsNumber
valueString
string
required
Example: 9995000180
object
name
string
required
Default: permissionCode
valueCoding
object
required
system
string
required
Default: https://fhir.nhs.uk/CodeSystem/SCR-ACSPermission
code
string
required

The following values are allowed: Yes, No, Ask

Response

HTTP status: 201

Permission successfully updated

HTTP status: 400

Bad request

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: fatal, error, warning, information
code
string
required

error code.

Example: invalid
details
object
text
string

detailed information

Example: NHS number missing
HTTP status: 401

Unauthorized

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: fatal, error, warning, information
code
string
required

error code.

Example: invalid
details
object
text
string

detailed information

Example: NHS number missing
HTTP status: 415

Unsupported Media Type, Content-Type header is invalid or missing

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: fatal, error, warning, information
code
string
required

error code.

Example: invalid
details
object
text
string

detailed information

Example: NHS number missing
HTTP status: 500

Internal Server Error

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation error outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: error
code
string
required

error code.

Example: unknown
details
object
coding
array
object
system
string
Default: https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode
version
string
Default: 1
code
string
Example: UNKNOWN_ERROR
display
string
Example: Unknown Error
diagnostics
string
Example: An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})

Send TMS Event Service (TES) message

post
/AuditEvent

Overview

Use this endpoint to record TMS Event Service (TES) Alerts centrally.

Sandbox test scenarios

You can test the following scenarios in our sandbox environment:

Scenario Request Response
Happy path nhsNumber=9995000180 HTTP Status 201

Request

Headers
Name Description
Authorization

String (^Bearer\ [[:ascii:]]+$)

An OAuth 2.0 bearer token. Required in all environments except sandbox.

Example: Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM

Required
X-Correlation-ID

String

A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.

Mirrored back in a response header.

Avoid . characters.

Example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

X-Request-ID

String

A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.

Must be a universally unique identifier (UUID) (ideally version 4). If you re-send a failed request, use the same value in this header. Mirrored back in a response header.

Pattern: /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

Example: 60E0B220-8136-4CA5-AE46-1D97EF59D068

NHSD-Session-URID

String

The user role ID (URID) for the current session. Also known as a user role profile ID (URPID).

If you are using User-restricted RESTful APIs - NHS login combined authentication and authorisation, See determin the user's role guidance. If you are using User-restricted RESTful APIs - NHS login separate authentication and authorisation, See determin the user's role guidance.

This field is optional.

Pattern: /^[0-9]+$/

Example: 555021935107

Content-Type

String

Used to indicate what type of data is actually sent

Example: application/fhir+json

Required
Body
Required

Content type: application/fhir+json

Example

Schema

Name Description
object
resourceType
string
required
Default: AuditEvent
id
string
required
Example: 1C03CF4F-D404-4D76-B192-4F81727059F6
extension
array
required

Notification message to be displayed on forwarding the Alert

object
url
string
required
Default: https://fhir.nhs.uk/StructureDefinition/Extension-SCR-NotificationMessage
valueString
string
required
Example: Alert: Permission to view override 1C03CF4F-D404-4D76-B192-4F81727059F6
type
object
required

Fixed value

system
string
required
Default: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
code
string
required
Default: access
display
string
required
Default: Access/View Record Lifecycle Event
subtype
array
required

A valueset to identify the reason a viewing alert has been triggered while viewing a Summary Care Record

Max items: 1
Min items: 1
object
system
string
required
Default: https://fhir.nhs.uk/CodeSystem/SCR-AlertReason
code
string
required
Allowed values: 0, 1, 2, 3, 4, 5
display
string
required
Example: Access made in the public interest
recorded
string
required

The time when the event was recorded

Example: 2020-11-13T00:00:00+00:00
agent
array
required
Max items: 3
Min items: 3
object

An actor taking an active role in the event or activity that is logged.

who
object
required
identifier
object
required
system
string
required
Example: https://fhir.nhs.uk/Id/sds-user-id
value
string
required
Example: T10101
role
array

Agent role in the event

object
text
string
required
Example: General Practitioner
requestor
boolean
required

Whether user is initiator

Default: false
source
object
required

The system that is reporting the event.

observer
object
required

The identity of source detecting the event

identifier
object
required
system
string
required
Default: https://fhir.nhs.uk/Id/nhsSpineASID
value
string
required
Example: 227319907548
entity
array
required

Specific instances of data or objects that have been accessed

object
what
object
required

Identifies a specific instance of the entity

identifier
object
required
value
string
required
Example: 1C03CF4F-D404-4D76-B192-4F81727059F6

Response

HTTP status: 201

Success response

HTTP status: 400

Bad request

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: fatal, error, warning, information
code
string
required

error code.

Example: invalid
details
object
text
string

detailed information

Example: NHS number missing
HTTP status: 401

Unauthorized

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: fatal, error, warning, information
code
string
required

error code.

Example: invalid
details
object
text
string

detailed information

Example: NHS number missing
HTTP status: 415

Unsupported Media Type, Content-Type header is invalid or missing

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: fatal, error, warning, information
code
string
required

error code.

Example: invalid
details
object
text
string

detailed information

Example: NHS number missing
HTTP status: 500

Internal Server Error

Body

Content type: application/fhir+json

Example

Schema

Name Description
object

Operation error outcome

resourceType
string

FHIR Resource Type.

Default: OperationOutcome
issue
array

List of issues that have occurred.

Min items: 1
object
severity
string
required

Severity of the error.

Allowed values: error
code
string
required

error code.

Example: unknown
details
object
coding
array
object
system
string
Default: https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode
version
string
Default: 1
code
string
Example: UNKNOWN_ERROR
display
string
Example: Unknown Error
diagnostics
string
Example: An unknown error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})

Get patient's Summary Care Record

get
/Bundle

Overview

Use this endpoint to retrieve the details of patient's Summary Care Record.

To get the information you must provide patient's NHS number and SCR UUID. UUID can be obtained using GET /DocumentReference endpoint.

If there's no patient's consent to share SCR the endpoint will return an empty bundle.

Sandbox test scenarios

You can test the following scenarios in our sandbox environment:

Scenario Request Response
Happy path composition.identifier=FA60BE64-1F34-11EB-A2A8-000C29A364EB Patient.identifier=9995000180 HTTP Status 200 - Full Bundle
No results composition.identifier=81CC2DA0-8882-11EB-B538-0800200C9A66 Patient.identifier=9693042298 HTTP Status 200 - Empty Bundle

Request

Query parameters
Name Description
composition.identifier

String

The patient's NHS number. Must be preceded with FHIR identifier (eg."composition.subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9995000180")

Example: FA60BE64-1F34-11EB-A2A8-000C29A364EB$composition.subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9995000180

Required
Headers
Name Description
Authorization

String (^Bearer\ [[:ascii:]]+$)

An OAuth 2.0 bearer token. Required in all environments except sandbox.

Example: Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM

Required
X-Correlation-ID

String

A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.

Mirrored back in a response header.

Avoid . characters.

Example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

X-Request-ID

String

A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.

Must be a universally unique identifier (UUID) (ideally version 4). If you re-send a failed request, use the same value in this header. Mirrored back in a response header.

Pattern: /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

Example: 60E0B220-8136-4CA5-AE46-1D97EF59D068

Response

HTTP status: 200

SCR successfully returned

Body

Content type: application/fhir+json

Example

Schema

Name Description
object
resourceType
string
required
Default: Bundle
id
string
Example: CE6B1A4F-51A4-4E03-AAB3-BA6113888E9F
identifier
object
required
system
string
Default: https://tools.ietf.org/html/rfc4122
value
string
Example: 10C71ECE-08F8-41D8-8A39-45D42DFC61D4
type
string

type of the Bundle

Default: searchset
timestamp
string
required
Example: 2007-03-15T01:00:00+00:00
total
integer

Total number of entries in the Bundle

Example: 58
entry
array
required
anyOf
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Composition/25FCE159-C82D-482B-8EA9-86DEF2C3929B
resource
object
resourceType
string
required
Default: Composition
id
string
Example: 25FCE159-C82D-482B-8EA9-86DEF2C3929B
meta
object
required
lastUpdated
string
required
Example: 2020-11-17T01:00:00+00:00
identifier
object
required
system
string
required
Default: https://tools.ietf.org/html/rfc4122
value
string
required
Example: C058D90F-E526-4A27-A46E-E86229096AAC
status
string
required
Default: final
type
object
required

Kind of composition

coding
array
required
Max items: 1
Min items: 1
object
system
string
required
Default: http://snomed.info/sct
code
string
required
Default: 196981000000101
display
string
required
Default: General Practice Summary
category
array
required
object
coding
array
required
object
system
string
required
Default: http://snomed.info/sct
code
string
required
Default: 163171000000105
display
string
required
Default: Care Professional Documentation
subject
object
required

Who and/or what the composition is about

reference
string
required
Example: Patient/B61AF2BD-0FFD-49CC-8374-C70DAFF8878F
date
string
required
Example: 2007-03-15T01:00:00+00:00
author
array
Min items: 1
object

Who and/or what authored the composition.

reference
string
required
Example: PractitionerRole/33661E10-AA36-491A-AFFE-5C10C0BF9304
display
string
Example: Dr Mark Spencer
title
string
required

Human Readable name/title

Example: General Practice Summary
relatesTo
array
object
code
string
Example: replaces
targetIdentifier
object
value
string
Example: D18B57ED-992E-45A2-A6AF-55200D20F48E
section
array
object
title
string
Example: Allergies and Adverse Reactions
text
object
status
string
Example: generated
div
string
Example: <div xmlns="http://www.w3.org/1999/xhtml"> <table summary="This table includes information about this patient's allergies and adverse reactions." id="Allergies"> <thead> <tr> <th>Date</th> <th>Description</th> <th>Certainty</th> <th>Severity</th> <th>Supporting Information</th> </tr> </thead> <tbody> <tr class="oddRow"> <td>12-May-2020</td> <td>Toxic reaction to wasp sting</td> <td/> <td/> <td>Problem; First</td> </tr> </tbody> </table> </div>
object
fullUrl
string

UUID identifying resource within a bundle

Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Patient/453863C3-C679-4D84-9E01-1B1D0239AC5F
resource
object
resourceType
string
required
Default: Patient
id
string
Example: 453863C3-C679-4D84-9E01-1B1D0239AC5F
identifier
array
required
object
extension
array
required
Max items: 1
Min items: 1
object
url
string
required
Example: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
valueCodeableConcept
object
required
coding
array
required
Max items: 1
Min items: 1
object
system
string
required
Example: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1
code
string
required
Example: 01
display
string
required
Example: Number present and verified
system
string
required
Default: https://fhir.nhs.uk/Id/nhs-number
value
string
required
Example: 9900004948
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD
resource
object
resourceType
string
required
Default: Practitioner
id
string
Example: F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD
identifier
array

There should be one identifier if user is a SDS USer

object
system
string
required

Should be fixed to https://fhir.nhs.uk/Id/sds-user-id when user is a SDS user

Default: https://fhir.nhs.uk/Id/sds-user-id
value
string
required

Filed mandatory when user is a SDS User

Example: 676789689789
name
array
object
text
string
Example: Mr. John Smith
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/FE7B9F77-3BC9-4D99-84DC-292D0762183C
resource
object
resourceType
string
required

Note: Either identifier with http://fhir.nhs.net/Id/sds-role-profile-id system is required or code with https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName. If PractitionerRole is referenced in Composition.Author resource in Summary Care Record upload case, PractitionerRole should reference Practitioner resource.

Default: PractitionerRole
id
string
Example: FE7B9F77-3BC9-4D99-84DC-292D0762183C
identifier
array
required
object
system
string
required
Default: http://fhir.nhs.net/Id/sds-role-profile-id
value
string
required
Example: 673836492727
practitioner
object
reference
string
Example: Practitioner/F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD
code
array
object
coding
array
object
system
string
Example: https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName
code
string
Example: R0070
display
string
Example: Associate Specialist
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/ADB4683E-BE01-4B08-AE36-079837BFF19E
resource
object
resourceType
string
required
Default: Condition
id
string
Example: ADB4683E-BE01-4B08-AE36-079837BFF19E
meta
array
object
profile
string
Default: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition
identifier
array
required
Max items: 1
Min items: 1
object
value
string
required
Example: 0F582D97-8F89-11EA-8B2D-B741F13EFC47
clinicalStatus
array
Max items: 1
object
coding
array
Max items: 1
Min items: 1
object
system
string
required
Default: http://terminology.hl7.org/CodeSystem/condition-clinical
code
string
required
Example: active
display
string
Example: Active
verificationStatus
array
Max items: 1
object
coding
array
Max items: 1
Min items: 1
object
system
string
required
Default: http://hl7.org/fhir/ValueSet/condition-ver-status
code
string
required
Example: confirmed
display
string
Example: Confirmed
category
array
required
Max items: 1
Min items: 1
object
coding
object
required
system
string
required
Default: http://snomed.info/sct
code
string
required
Example: 163001000000103
display
string
required
Example: Diagnoses
code
object
required

Following SNOMED CT concept IDs are supported (see more):

  • 1240751000000100 COVID-19
  • 1240761000000102 COVID-19 confirmed by laboratory test
  • 1300731000000106 COVID-19 confirmed using clinical diagnostic criteria
  • 1300721000000109 Suspected COVID-19
coding
array
required
Max items: 1
Min items: 1
object
system
string
required
Example: http://snomed.info/sct
code
string
required
Example: 1240631000000102
display
string
required
Example: Did not attend SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination
onsetDateTime
string
Example: 2020-05-06T10:48:19+00:00
evidence
array

Supporting evidence - should link Observation resource

Min items: 1
object
detail
array
required
object
reference
string
required

Reference to related Observation resource

Example: Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49
note
array

Additional information about the Condition

Max items: 1
Min items: 1
object
text
string
required
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/6E1B91CC-C25A-4466-94A6-DFDE260C12AB
resource
object
resourceType
string
Default: Encounter
id
string
Example: 6E1B91CC-C25A-4466-94A6-DFDE260C12AB
status
string
Default: finished
class
object
system
string
Default: http://terminology.hl7.org/CodeSystem/v3-NullFlavor
code
string
Default: UNK
display
string
Default: Unknown
participant
array
object
type
array
required
Max items: 1
Min items: 1
object
coding
array
Max items: 1
Min items: 1
object
system
string
required
Default: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
code
string
required
Allowed values: AUT, PRF, INF
display
string
Example: author
period
object
required
start
string
required
Example: 2020-11-17T01:00:00+00:00
individual
object
required
reference
string
required
Example: PractitionerRole/1CB6874C-67C4-4A3B-BE24-3D574382D464
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/FD3F2E98-511F-4A3E-AD84-127DAEC1645E
resource
object
resourceType
string
required
Default: Organization
id
string
Example: FD3F2E98-511F-4A3E-AD84-127DAEC1645E
identifier
array

Organization identifier. Mandatory for SDS organizations.

object
use
string
Example: official
system
string
Default: https://fhir.nhs.uk/Id/ods-organization-code
value
string
Example: RR8
type
array
object
coding
array
object
code
string
Example: 021
name
string
Example: LEEDS TEACHING HOSPITAL TRUST
telecom
array
object
system
string
Example: phone
value
string
Example: 0113 243 3144
address
array
object
text
string
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/RelatedPerson/086DE219-FEDF-41D4-BA5D-55EE3B1CAE9F
resource
object
resourceType
string
required
Default: RelatedPerson
id
string
Example: 086DE219-FEDF-41D4-BA5D-55EE3B1CAE9F
relationship
array
required
Max items: 1
Min items: 1
object
coding
array
required
Max items: 1
Min items: 1
object
system
string
required
Default: https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1
code
string
required
Example: 01
display
string
required
Example: Brother
name
array
required
object
text
string
Example: Mr. John Smith
object
fullUrl
string
Example: https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/02778CD7-E78E-4BF5-9B05-1C634275DB91
resource
object
resourceType
string
required
Default: Observation
id
string
Example: 02778CD7-E78E-4BF5-9B05-1C634275DB91
meta
array
Max items: 1
Min items: 1
object
profile
string
Default: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation