{"openapi":"3.0.0","info":{"version":"v3.0.19-alpha","title":"Summary Care Record API","description":"\n
\n
\n
\n
\n \n \"\"\n \n
\n
\n
\n

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

\n
\n
\n
\n\n## Version\nThe current released version of this API is 3.0 while minor updates may be available on PTL environments.\n\n## Overview\nUse this API to access or update a patient's [Summary Care Record (SCR)](https://digital.nhs.uk/services/summary-care-records-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.\n\nThis API is currently only approved for use in primary care software, specifically GP software. We hope to make it available for secondary care in the future.\n\nAlso use this API to update a patient's SCR Consent Preference on the Spine ACS and to raise electronic Alerts when:\n* a SCR is accessed without the patient's permission\nand/or\n* the equivalent of Self-Claim Legitimate Relationship is created by an individual, who subsequently accesses the patient's SCR\n* send an SCR alert message, on those occasions when an SCR is accessed without the patient's permission e.g., in an emergency or when the equivalent of Self-Claim Legitimate Relationship is created.\n* update a patient's SCR Consent Preference on the Spine ACS\n\nYou can:\n* get a patient's SCR identifier\n* get a patient's SCR\n* upload a patient's SCR\n* send a privacy alert message, if you have to override a patient's dissent to view their SCR \n* update a patient's SCR Consent Preference on the Spine ACS\n\nA health or care staff providing direct care to patients must be present and authenticated with an [NHS smartcard or a modern alternative](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/nhs-smartcards-for-developers) to use this API.\n\n## Who can use this API\nThis 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).\n\nThis API is initially for use by new market entrant GP IT developers with other use cases to follow later.\n\n## Related APIs\nTo use this API, you need the patient's NHS number, which can be retrieved by using the following API:\n - [Personal Demographics Service (FHIR) API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) - 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.\n\nThis API has endpoints enabling you to get and set access permissions, the same as the [Access Control Service (ACS) HL7 V3 API](https://digital.nhs.uk/developer/api-catalogue/access-control-service-hl7-v3) which it partly replaces.\n\n## API status and roadmap\nThis API is initially for use by new market entrant GP IT developers with other use cases to follow later.\n\nThis API is [in production, beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses), meaning:\n\n- the API is available in our sandbox and integration test environments\n- the API is available for production (private beta) use\n- we might make breaking changes, but only if we cannot avoid it, and we'll give advance notice\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\n\nIt conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange, specifically to [FHIR R4 (v4.0.1)](https://hl7.org/fhir/r4/), except that it does not support the [capabilities](https://hl7.org/fhir/R4/http.html#capabilities) interaction.\n\nIt includes some country-specific FHIR extensions, which are built against [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), specifically [UK.core.r4.v2 2.0.5](https://simplifier.net/packages/uk.core.r4.v2/2.0.5).\n\nThe interactions between the SCR FHIR API and Spine have been tested with a wide range of special characters including emojis with appropriate Fitzpatrick modifiers. In accordance with HL7-FHIR specifications, this API operates with UTF-8 encoding.\n\n## Network access\nThis API is available on the internet and indirectly on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\nThis API has two authorisation methods. The first is [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis), meaning an end user must be present and authenticated to use it.\n\nThe end user must be:\n- a health or care worker providing direct care to patients\n- strongly authenticated, using either an [NHS smartcard or a modern alternative](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/nhs-smartcards-for-developers) available via [CIS2 Authentication](https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication)\n- authenticated to assurance level AAL2 or AAL3\n\nThe API uses OAuth 2.0 to authorise the calling system. It supports the following security patterns:\n- [user-restricted RESTful API - CIS2 - combined authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation)\n- [user-restricted RESTful API - CIS2 - seperate authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-cis2-separate-authentication-and-authorisation)\n\nThe second authorisation method is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning a few specific API calls can be authorised by the application making the requests. This is typically provided so that GPs can perform batch updates of multiple Summary Care Records without having to log in as a specific user.\n\nThe following specific endpoint and method combinations can be used with application-restricted authentication, in addition to user-restricted authentication:\n\n- GET DocumentReference\n- GET Bundle\n- POST Bundle\n\nFor more details, see the following security pattern: \n- [application-restricted RESTful APIs - signed with JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\n## Environments and testing\n| Purpose | Base URL |\n| ---------------------------------------|-----------------------------------------------------|\n| Sandbox | `https://sandbox.api.service.nhs.uk/summary-care-record/FHIR/R4`|\n| Integration test | `https://int.api.service.nhs.uk/summary-care-record/FHIR/R4` |\n| Production | `https://api.service.nhs.uk/summary-care-record/FHIR/R4` |\n\n## NME testing\nThe approach to testing for external developers is as follows.\n\nFor sandbox, New Market Entrants (NMEs) should perform Self Testing, followed by Integration Testing which will be available on the Assurance Technical Evidencing. NMEs need to meet these to progress in integration.\n\n### Sandbox testing\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\n - is for early developer testing\n - only covers a limited set of scenarios\n - is stateless, so it does not actually persist any updates\n - is open access, so does not allow you to test authorisation\n\n For more details on sandbox testing, or to try out the sandbox using our \\\"Try this API\\\" feature, see the documentation for each endpoint.\n\n### Integration testing\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):\n\n* is for formal integration testing\n* is stateful, so persists updates\n* includes authorisation, with [smartcard](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/nhs-smartcards-for-developers) and non-smartcard options\n\nIt also includes ready-to-use [summary care record test data](https://digital.nhs.uk/developer/api-catalogue/summary-care-record-fhir/summary-care-record-fhir-api-test-data).\n\nFor more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis). \n\n### Production\nOur [production environment](https://digital.nhs.uk/services/path-to-live-environments):\n\n* is for formal use in a live environment\n* is stateful, so persists updates\n* includes authorisation, with [smartcard](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/nhs-smartcards-for-developers)\n\nFor more information about our Production Environment, contact the [National Service Desk](ssd.nationalservicedesk@nhs.net)\n\n## Onboarding\nYou 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.\n\nAs part of this process, you need to demonstrate that you can manage risks and that your software conforms technically with the requirements for this API.\n\nInformation on this page might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/developer/api-catalogue/summary-care-record-fhir/onboarding-support-information).\n\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n\n
\n
\n
\n
\n \n \"\"\n \n
\n
\n
\n

To get started, sign in or create a developer account, then select 'product onboarding'.

\n
\n
\n
\n\n### Troubleshooting\n\n* After setting up your new application through the NHS Developer Portal and connecting it to the Summary Care Record API, you will need to ensure your application has a valid ASID custom attribute. ITOC support services should be able to ensure your ASID values are setup to use the [QUPC_IN190000UK04](https://data.developer.nhs.uk/dms/mim/4.2.00/Domains/PSIS%20Query/Document%20files/PSIS%20Query%20IM.htm#_Toc_Section_6.2) interaction. This interaction is for access to resources on Personal Spine Information Service (PSIS), the former name of Summary Care Record. If this isn't setup, you may encounter 403 Forbidden errors when accessing records. This can be checked by emailing [itoc.supportdesk@nhs.net](mailto:itoc.supportdesk@nhs.net).\n* ITOC should also be able to apply the GP summary v3 message set to the endpoints for you.\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n* 400 to 499 if it failed because of a client error by your application\n* 500 to 599 if it failed because of an error on our server\n\nErrors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n\n## Exponential backoff\nIn the event of a transitory error:\n\n* 429 - exceeded application rate limit (5 TPS per application)\n* 500 - internal server error\n* 503 - service unavailable\n* 504 - response timed out\n\nThe following retries are recommended:\n\n* Attempt 1: 1 minute after first failure\n* Attempt 2: 30 minutes after attempt 1\n* Attempt 3: 60 minutes after attempt 2\n* Attempt 4: 2 hours after attempt 3\n* Attempt 5: 4 hours after attempt 4\n* Attempt 6: 8 hours after attempt 5\n* Attempt 7: 16 hours after attempt 6\n* If attempt 7 fails, then fail permanently.\n\n## Support\nSupport for new market entrants integrating with this adaptor can be provided by raising a support ticket via the follow methods, please quote ‘SCR FHIR API’ when raising.\n\nFor technical support enquiries:\n\n* email the National Service Desk [ssd.nationalservicedesk@nhs.net](ssd.nationalservicedesk@nhs.net) or visit the [NHS Digital Customer Portal](https://www.support.digitalservices.nhs.uk/csm) \n* telephone 0300 303 5035\n\nFor general enquiries:\n\n* email [enquiries@nhsdigital.nhs.uk](mailto:enquiries@nhsdigital.nhs.uk)\n\n## Operations\nHere are the links to the possible SCR operations. These endpoints are for create and consume use cases for GP systems:\n* [Get patient's Summary Care Record](#get-/Bundle)\n* [Upload patient's Summary Care Record](#post-/Bundle)\n* [Get patient's latest Summary Care Record identifier](#get-/DocumentReference)\n* [Update patient's consent to share SCR](#post-/$setPermission)\n* [Send a privacy alert message](#post-/AuditEvent)\n\n## Contact us\nFor help and support connecting to our APIs and to join our developer community, see [Help and support building healthcare software](https://digital.nhs.uk/developer/help-and-support).\n","license":{"name":"MIT"},"contact":{"name":"Summary Care Record FHIR API Support","url":"https://digital.nhs.uk/developer/help-and-support","email":"api.management@nhs.net"}},"x-nhsd-api-platform":{"meta":{"name":"Summary Care Record API","canonical_name":"summary-care-record","short_name":"scr","description":"This is a generated template API","pipeline_name_prefix":"Summary-Care-Record"}},"servers":[{"url":"https://sandbox.api.service.nhs.uk/summary-care-record/FHIR/R4","description":"Sandbox environment"},{"url":"https://int.api.service.nhs.uk/summary-care-record/FHIR/R4","description":"Integration test environment."}],"x-spec-publication":{"operation-order":[{"operations":[{"method":"GET","path":"/DocumentReference"},{"method":"GET","path":"/Bundle"},{"method":"POST","path":"/Bundle"},{"method":"POST","path":"/AuditEvent"},{"method":"POST","path":"/$setPermission"}]}]},"paths":{"/Bundle":{"post":{"description":"## Overview\nUse this endpoint to upload the details of patient's Summary Care Record.\n\nTo execute the upload you must provide patient's NHS number.\nIn case of an update, before executing the request, latest UUID must be obtained using GET /DocumentReference endpoint\nand set inside the request body.\n\n## Usage diagram\n![POST SCR Diagram](https://raw.githubusercontent.com/NHSDigital/summary-care-record-api/various-documentation-changes/specification/components/resources/images/diagram-1.jpg)\n\n## Sandbox test scenarios\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------------| ------------------------------------------------- | -------------------- |\n| Happy path | `Patient.identifier.value`=`9000000009` | HTTP Status 201 |\n| No patient's consent to store SCR | `Patient.identifier.value`=`9111231130` | HTTP Status 403 |\n","summary":"Upload patient's Summary Care Record","operationId":"upload-scr","parameters":[{"in":"header","name":"Authorization","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},{"in":"header","name":"X-Correlation-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.\n\nWhen contacting the helpdesk and asking them to trace logs in Splunk, please supply the X-Correlation-ID (GIUD) from the request you are attempting to debug.\n\nMirrored back in a response header.\n\nAvoid `.` characters.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\nIf you re-send a failed request, use the same value in this header.\nMirrored back in a response header.\n","schema":{"type":"string","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"}},{"in":"header","name":"NHSD-Session-URID","description":"\nThe user role ID (URID) for the current session. Also known as a user role profile ID (URPID).\n\nIn user-restricted access mode if you send this header it must be valid for the logged-in user. See [determine the user's role](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation#step-7-determine-the-user-s-role) for guidance.\n","required":false,"schema":{"type":"string","pattern":"^[0-9]+$","example":"555021935107"}},{"in":"header","name":"Content-Type","description":"Used to indicate what type of data is actually sent\n","required":true,"schema":{"type":"string","example":"application/fhir+json"}}],"requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","default":"Bundle"},"id":{"type":"string","example":"582B5B22-062C-47E2-BCC0-7C6A77D96ABA"},"identifier":{"type":"object","properties":{"system":{"type":"string","default":"https://tools.ietf.org/html/rfc4122"},"value":{"type":"string","example":"C058D90F-E526-4A27-A46E-E86229096AAC"}},"required":["system","value"]},"type":{"description":"type of the Bundle","type":"string","default":"document"},"timestamp":{"type":"string","example":"2007-03-15T01:00:00+00:00"},"entry":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Composition/25FCE159-C82D-482B-8EA9-86DEF2C3929B"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Composition"},"id":{"type":"string","example":"25FCE159-C82D-482B-8EA9-86DEF2C3929B"},"meta":{"type":"object","properties":{"lastUpdated":{"type":"string","example":"2020-11-17T01:00:00+00:00"}},"required":["lastUpdated"]},"identifier":{"type":"object","properties":{"system":{"type":"string","default":"https://tools.ietf.org/html/rfc4122"},"value":{"type":"string","example":"C058D90F-E526-4A27-A46E-E86229096AAC"}},"required":["system","value"]},"status":{"type":"string","default":"final"},"type":{"description":"Kind of composition","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","default":"196981000000101"},"display":{"type":"string","default":"General Practice Summary"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","default":"163171000000105"},"display":{"type":"string","default":"Care Professional Documentation"}},"required":["system","code","display"]}}},"required":["coding"]}},"subject":{"description":"Who and/or what the composition is about","type":"object","properties":{"reference":{"type":"string","example":"Patient/B61AF2BD-0FFD-49CC-8374-C70DAFF8878F"}},"required":["reference"]},"date":{"type":"string","example":"2007-03-15T01:00:00+00:00"},"author":{"type":"array","items":{"description":"Who and/or what authored the composition. This field should reference PractitionerRole resource containing a link to Practitioner","type":"object","properties":{"reference":{"type":"string","example":"PractitionerRole/33661E10-AA36-491A-AFFE-5C10C0BF9304"},"display":{"type":"string","example":"Dr Steve Jones"}},"required":["reference"]},"minItems":1},"title":{"description":"Human Readable name/title","type":"string","example":"General Practice Summary"},"relatesTo":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"replaces"},"targetIdentifier":{"description":"SCR UUID. Must be set in case of an update, can be obtained using GET /DocumentReference endpoint.","type":"object","properties":{"value":{"type":"string","example":"D18B57ED-992E-45A2-A6AF-55200D20F48E"}}}}}},"section":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","example":"Allergies and Adverse Reactions"},"text":{"type":"object","properties":{"status":{"type":"string","example":"generated"},"div":{"type":"string","example":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionCertaintySeveritySupporting Information
12-May-2020Toxic reaction to wasp sting\n \n Problem; First
\n
"}}}}}}},"required":["resourceType","meta","identifier","status","type","category","subject","date","title"]}}},{"type":"object","properties":{"fullUrl":{"description":"UUID identifying resource within a bundle","type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Patient/453863C3-C679-4D84-9E01-1B1D0239AC5F"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Patient"},"id":{"type":"string","example":"453863C3-C679-4D84-9E01-1B1D0239AC5F"},"identifier":{"type":"array","items":{"type":"object","properties":{"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1"},"valueCodeableConcept":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1"},"code":{"type":"string","example":"01"},"display":{"type":"string","example":"Number present and verified"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]}},"required":["url","valueCodeableConcept"]},"minItems":1,"maxItems":1},"system":{"type":"string","default":"https://fhir.nhs.uk/Id/nhs-number"},"value":{"type":"string","example":"9000000009"}},"required":["extension","system","value"]}}},"required":["resourceType","identifier"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Practitioner"},"id":{"type":"string","example":"F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD"},"identifier":{"type":"array","description":"There should be one identifier if user is a SDS USer","items":{"type":"object","properties":{"system":{"description":"Should be fixed to https://fhir.nhs.uk/Id/sds-user-id when user is a SDS user","type":"string","default":"https://fhir.nhs.uk/Id/sds-user-id"},"value":{"type":"string","description":"Filed mandatory when user is a SDS User","example":"676789689789"}},"required":["system","value"]}},"name":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"Mr. John Smith"}}}}},"required":["resourceType"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/FE7B9F77-3BC9-4D99-84DC-292D0762183C"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"PractitionerRole","description":"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."},"id":{"type":"string","example":"FE7B9F77-3BC9-4D99-84DC-292D0762183C"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://fhir.nhs.net/Id/sds-role-profile-id"},"value":{"type":"string","example":"673836492727"}},"required":["system","value"]}},"practitioner":{"type":"object","properties":{"reference":{"type":"string","example":"Practitioner/F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD"}}},"organization":{"type":"object","properties":{"reference":{"type":"string","example":"Organization/90588362-F342-423F-AB6F-B5E92B20C6B6"}}},"code":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName"},"code":{"type":"string","example":"R0070"},"display":{"type":"string","example":"Associate Specialist"}}}}}}}},"required":["resourceType","identifier"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/ADB4683E-BE01-4B08-AE36-079837BFF19E"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Condition"},"id":{"type":"string","example":"ADB4683E-BE01-4B08-AE36-079837BFF19E"},"meta":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string","default":"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"}}}},"identifier":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"0F582D97-8F89-11EA-8B2D-B741F13EFC47"}},"required":["value"]},"minItems":1,"maxItems":1},"clinicalStatus":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://terminology.hl7.org/CodeSystem/condition-clinical"},"code":{"type":"string","example":"active"},"display":{"type":"string","example":"Active"}},"required":["system","code"]},"minItems":1,"maxItems":1}}},"maxItems":1},"verificationStatus":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://hl7.org/fhir/ValueSet/condition-ver-status"},"code":{"type":"string","example":"confirmed"},"display":{"type":"string","example":"Confirmed"}},"required":["system","code"]},"minItems":1,"maxItems":1}}},"maxItems":1},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","example":"163001000000103"},"display":{"type":"string","example":"Diagnoses"}},"required":["system","code","display"]}},"required":["coding"]},"minItems":1,"maxItems":1},"code":{"description":"Following SNOMED CT concept IDs are supported [(see more)](https://digital.nhs.uk/services/summary-care-records-scr/coronavirus-covid-19-message-in-scr):\n* 1240751000000100 COVID-19\n* 1240761000000102 COVID-19 confirmed by laboratory test\n* 1300731000000106 COVID-19 confirmed using clinical diagnostic criteria\n* 1300721000000109 Suspected COVID-19\n","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"http://snomed.info/sct"},"code":{"type":"string","example":"1240631000000102"},"display":{"type":"string","example":"Did not attend SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]},"onsetDateTime":{"type":"string","example":"2020-05-06T10:48:19+00:00"},"evidence":{"description":"Supporting evidence - should link Observation resource","type":"array","items":{"type":"object","properties":{"detail":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string","example":"Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49","description":"Reference to related Observation resource"}},"required":["reference"]}}},"required":["detail"]},"minItems":1},"note":{"description":"Additional information about the Condition","type":"array","items":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]},"minItems":1,"maxItems":1}},"required":["resourceType","identifier","status","category","code"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/6E1B91CC-C25A-4466-94A6-DFDE260C12AB"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Encounter"},"id":{"type":"string","example":"6E1B91CC-C25A-4466-94A6-DFDE260C12AB"},"status":{"type":"string","default":"finished"},"class":{"type":"object","properties":{"system":{"type":"string","default":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor"},"code":{"type":"string","default":"UNK"},"display":{"type":"string","default":"Unknown"}}},"participant":{"type":"array","items":{"type":"object","properties":{"type":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType"},"code":{"type":"string","enum":["AUT","PRF","INF"],"example":"AUT"},"display":{"type":"string","example":"author"}},"required":["system","code"]},"minItems":1,"maxItems":1}}},"minItems":1,"maxItems":1},"period":{"type":"object","properties":{"start":{"type":"string","example":"2020-11-17T01:00:00+00:00"}},"required":["start"]},"individual":{"type":"object","properties":{"reference":{"type":"string","example":"PractitionerRole/1CB6874C-67C4-4A3B-BE24-3D574382D464"}},"required":["reference"]}},"required":["type","period","individual"]}}}}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/FD3F2E98-511F-4A3E-AD84-127DAEC1645E"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Organization"},"id":{"type":"string","example":"FD3F2E98-511F-4A3E-AD84-127DAEC1645E"},"identifier":{"description":"Organization identifier. Mandatory for SDS organizations.","type":"array","items":{"type":"object","properties":{"use":{"type":"string","example":"official"},"system":{"type":"string","default":"https://fhir.nhs.uk/Id/ods-organization-code"},"value":{"type":"string","example":"RR8"}}}},"type":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"021"}}}}}}},"name":{"type":"string","example":"LEEDS TEACHING HOSPITAL TRUST"},"telecom":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"phone"},"value":{"type":"string","example":"0113 243 3144"}}}},"address":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}}},"required":["resourceType"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/RelatedPerson/086DE219-FEDF-41D4-BA5D-55EE3B1CAE9F"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"RelatedPerson"},"id":{"type":"string","example":"086DE219-FEDF-41D4-BA5D-55EE3B1CAE9F"},"relationship":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1"},"code":{"type":"string","example":"01"},"display":{"type":"string","example":"Brother"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]},"minItems":1,"maxItems":1},"name":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"Mr. John Smith"}}}}},"required":["resourceType","relationship","name"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/02778CD7-E78E-4BF5-9B05-1C634275DB91"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Observation"},"id":{"type":"string","example":"02778CD7-E78E-4BF5-9B05-1C634275DB91"},"meta":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string","default":"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"}}},"minItems":1,"maxItems":1},"identifier":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"0F582D97-8F89-11EA-8B2D-B741F13EFC47"}},"required":["value"]},"minItems":1,"maxItems":1},"status":{"type":"string","enum":["final","entered-in-error"],"example":"final"},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","example":"163001000000104"},"display":{"type":"string","example":"Investigation Results"}},"required":["system","code"]}},"required":["coding"]},"minItems":1,"maxItems":1},"code":{"description":"Following SNOMED CT concept IDs are supported [(see more)](https://digital.nhs.uk/services/summary-care-records-scr/coronavirus-covid-19-message-in-scr):\n* 1240581000000104 SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive\n","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"http://snomed.info/sct"},"code":{"type":"string","example":"1240631000000102"},"display":{"type":"string","example":"Did not attend SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination"}},"required":["system","code","display"]}}},"required":["coding"]},"effectivePeriod":{"type":"object","properties":{"start":{"type":"string","example":"2020-05-06T10:48:19+00:00"},"end":{"type":"string","example":"2020-05-26T11:56:18+00:00"}}}},"required":["resourceType","identifier","status","category","code"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Device/C5F6616C-AA6F-4A8C-85FF-0183C3D15D37"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Device"},"id":{"type":"string","example":"C5F6616C-AA6F-4A8C-85FF-0183C3D15D37"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.nhs.uk/Id/SDSDevice"},"value":{"type":"string","example":"7867868687687"}},"required":["value"]},"minItems":1},"deviceName":{"description":"The name of the device as given by the manufacturer","type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"other"},"type":{"type":"string","example":"manufacturer-name"}}}},"type":{"description":"The kind or type of device. Field is mandatory when device is NOT a SDS Device.","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"707728009"},"display":{"type":"string","example":"Device system"}},"required":["code","display"]}}},"required":["coding"]},"version":{"description":"The actual design of the device or software version running on the device","type":"object","properties":{"value":{"type":"string","example":"1.0.0"}}},"owner":{"description":"Organization responsible for device","type":"object","properties":{"reference":{"type":"string","example":"Organization/2FF8C5EC-E517-421A-B4A4-D7EAAA1EFE12"}}},"note":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"Additional information"}}}}},"required":["resourceType"]}}}]}}},"required":["resourceType","identifier","type","timestamp","entry"]},"examples":{"Example JSON SCR Bundle":{"summary":"Example JSON SCR Bundle","value":{"resourceType":"Bundle","id":"28E24A01-5D33-4173-B5CE-82C004948815","identifier":{"system":"https://tools.ietf.org/html/rfc4122","value":"821533D3-3E0F-11EB-8111-F40343488B16"},"type":"document","timestamp":"2020-12-14T13:23:10+00:00","entry":[{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Composition/BF4180FD-C403-4EF7-A4AB-E07303AF5477","resource":{"resourceType":"Composition","id":"BF4180FD-C403-4EF7-A4AB-E07303AF5477","meta":{"lastUpdated":"2020-11-17T01:00:00+00:00"},"identifier":{"system":"https://tools.ietf.org/html/rfc4122","value":"BF4180FD-C403-4EF7-A4AB-E07303AF5477"},"status":"final","type":{"coding":[{"system":"http://snomed.info/sct","code":"196981000000101","display":"General Practice Summary"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163171000000105","display":"Care Professional Documentation"}]}],"subject":{"reference":"Patient/565B3BEF-9A19-4763-8887-9F7CB75995E3"},"date":"2020-11-17T01:00:00+00:00","author":[{"reference":"PractitionerRole/C89A53D3-E063-4023-B89C-1A105ABAABB7"}],"relatesTo":[{"code":"replaces","targetIdentifier":{"value":"D18B57ED-992E-45A2-A6AF-55200D20F48E"}}],"section":[{"title":"General Practice Summary","code":{"coding":[{"code":"Title"}]},"text":{"status":"generated","div":"
\n

Sourced from the patient's General Practice record. This summary may not include all the information pertinent to this patient.

\n

Summary Created: 14-May-2020 14:31

\n

At the time this record was created, this patient had recently registered with the GP Practice. GP Summary information may not be complete.

\n

Created by: SMITH, Sean (Mr)

\n

EMISWebCR1 50004, Fulford Grange, Rawdon, Leeds, West Yorkshire, LS19 7BY.

\n
"}},{"title":"Allergies and Adverse Reactions","code":{"coding":[{"code":"AllergiesHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionCertaintySeveritySupporting Information
12-May-2020Toxic reaction to wasp sting\n \n Problem; First
\n
"}},{"title":"Acute Medications (For the 12 month period 14-May-2019 to 14-May-2020)","code":{"coding":[{"code":"AcuteMedsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TypeDateMedication ItemDosage InstructionsQuantity
Acute MedicationPrescribed: 12-May-2020Co-codamol 8mg/500mg effervescent tabletsOne To Be Taken Four Times A Day112 tablet
\n
"}},{"title":"Current Repeat Medications","code":{"coding":[{"code":"RepeatMedsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TypeDateMedication ItemDosage InstructionsQuantity
Repeat MedicationLast Issued: 12-May-2020Paracetamol 250mg/5ml oral suspensionOne 5ml Spoonful Every 4 To 6 Hours When Necessary. No More Than 4 doses in 24 Hours40 ml
\n
"}},{"title":"Discontinued Repeat Medications (For the 6 month period 14-Nov-2019 to 14-May-2020)","code":{"coding":[{"code":"DiscRepeatMedsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TypeDateMedication ItemDosage InstructionsQuantity
No relevant information available for this category.
\n
"}},{"title":"Risks to Patient","code":{"coding":[{"code":"RisksToPatientHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
14-May-2020Low risk category for developing complication from COVID-19 infectionProblem; Review
\n
"}},{"title":"Diagnoses","code":{"coding":[{"code":"DiagnosesHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
13-May-2020COVID-19 confirmed by laboratory testProblem; First, test
\n
"},"entry":[{"reference":"Condition/FCB84E15-02E5-495C-B334-D0685DCB0687"},{"reference":"Condition/0F582D97-8F89-11EA-8B2D-B741F13EFC47"},{"reference":"Condition/958E584C-25B8-4BD7-A71D-7625FDC1ACD6"},{"reference":"Condition/8CEB2867-551B-43D0-88B5-3278DA20A6B0"},{"reference":"Condition/6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70"}]},{"title":"Problems and Issues","code":{"coding":[{"code":"ProblemsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
14-May-20202019-nCoV (novel coronavirus) detectedSignificant Active
\n
"}},{"title":"Clinical Observations and Findings","code":{"coding":[{"code":"ObservationsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
14-May-20202019-nCoV (novel coronavirus) detectedProblem; New
\n
"}},{"title":"Treatments","code":{"coding":[{"code":"TreatmentsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
13-May-20202019-nCoV (novel coronavirus) vaccinationProblem; First, Manufacturer: jh, Expiry Date: 29-May-2020, Batch Number: 2, GMS: GMS, Injection site: Left arm, test
\n
"}},{"title":"Investigation Results","code":{"coding":[{"code":"ResultsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
13-May-2020Assessment using COVID-19 severity scaleProblem; First, test
\n
"},"entry":[{"reference":"Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49"},{"reference":"Observation/EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0"},{"reference":"Observation/0F582D97-8F89-11CA-8B2D-B741F13EFC47"}]},{"title":"Care Events","code":{"coding":[{"code":"EventsHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
13-May-2020Did not attend 2019-nCoV (novel coronavirus) vaccinationProblem; First, test
\n
"}},{"title":"Administrative Procedures","code":{"coding":[{"code":"ProceduresHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
14-May-2020Household isolation note issued to patientTest
\n
"}},{"title":"Provision of Advice and Information to Patients and Carers","code":{"coding":[{"code":"AdviceHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
13-May-2020Advice given about SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) by telephoneProblem; First, test
\n
"}},{"title":"Personal Preferences","code":{"coding":[{"code":"PreferencesHeader"}]},"text":{"status":"generated","div":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionAdditional information
13-May-20202019-nCoV (novel coronavirus) vaccination declinedProblem; First, test
\n

Summary Sent: 14-May-2020 14:31

\n
"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/C89A53D3-E063-4023-B89C-1A105ABAABB7","resource":{"resourceType":"PractitionerRole","id":"C89A53D3-E063-4023-B89C-1A105ABAABB7","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"673836492727"}],"practitioner":{"reference":"Practitioner/7EB18277-C51A-4AEA-9D93-0B12BB0E140D"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/7EB18277-C51A-4AEA-9D93-0B12BB0E140D","resource":{"resourceType":"Practitioner","id":"7EB18277-C51A-4AEA-9D93-0B12BB0E140D","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"676789689789"}],"name":[{"text":"Dr Steve Jones"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/FCB84E15-02E5-495C-B334-D0685DCB0687","resource":{"resourceType":"Condition","id":"FCB84E15-02E5-495C-B334-D0685DCB0687","identifier":[{"value":"FCB84E15-02E5-495C-B334-D0685DCB0687"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240751000000100","display":"COVID-19"}]},"encounter":{"reference":"Encounter/DE2F2DAB-5BB1-480C-AA67-A2A68D06620D"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/29325FBB-AA13-4645-BAE4-314AD6D21083","resource":{"resourceType":"PractitionerRole","id":"29325FBB-AA13-4645-BAE4-314AD6D21083","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"673836492727"}],"practitioner":{"reference":"Practitioner/20CE162F-C21A-4B87-8ABC-2FA927AAB65F"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/20CE162F-C21A-4B87-8ABC-2FA927AAB65F","resource":{"resourceType":"Practitioner","id":"20CE162F-C21A-4B87-8ABC-2FA927AAB65F","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"676789689789"}],"name":[{"text":"Dr Steve Jones"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/DE2F2DAB-5BB1-480C-AA67-A2A68D06620D","resource":{"resourceType":"Encounter","id":"DE2F2DAB-5BB1-480C-AA67-A2A68D06620D","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-11-17T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/29325FBB-AA13-4645-BAE4-314AD6D21083"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/0F582D97-8F89-11EA-8B2D-B741F13EFC47","resource":{"resourceType":"Condition","id":"0F582D97-8F89-11EA-8B2D-B741F13EFC47","identifier":[{"value":"0F582D97-8F89-11EA-8B2D-B741F13EFC47"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1300721000000109","display":"COVID-19 confirmed by laboratory test"}]},"encounter":{"reference":"Encounter/920DCE4E-3E44-4966-B7C4-B61DAB9E4FDE"},"onsetDateTime":"2020-05-06T12:48:19+00:00","evidence":[{"detail":[{"reference":"Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49"}]}],"note":[{"text":"Problem; First, test"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/4E7AFF7E-FD68-4C52-A8C5-89268F1FDE5D","resource":{"resourceType":"Practitioner","id":"4E7AFF7E-FD68-4C52-A8C5-89268F1FDE5D","name":[{"text":"BLOGGS Fred"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/4EAE23ED-8F8D-455B-A15E-96B077F02411","resource":{"resourceType":"PractitionerRole","id":"4EAE23ED-8F8D-455B-A15E-96B077F02411","practitioner":{"reference":"Practitioner/4E7AFF7E-FD68-4C52-A8C5-89268F1FDE5D"},"organization":{"reference":"Organization/CD7FAF21-0126-456E-B681-703571153CA3"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0050","display":"Consultant"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/CD7FAF21-0126-456E-B681-703571153CA3","resource":{"resourceType":"Organization","id":"CD7FAF21-0126-456E-B681-703571153CA3","telecom":[{"system":"phone","value":"0177865579"},{"system":"phone","value":"0189834144"}],"address":[{"text":"ORG ADDRESS"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/920DCE4E-3E44-4966-B7C4-B61DAB9E4FDE","resource":{"resourceType":"Encounter","id":"920DCE4E-3E44-4966-B7C4-B61DAB9E4FDE","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-11-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/4EAE23ED-8F8D-455B-A15E-96B077F02411"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/958E584C-25B8-4BD7-A71D-7625FDC1ACD6","resource":{"resourceType":"Condition","id":"958E584C-25B8-4BD7-A71D-7625FDC1ACD6","identifier":[{"value":"958E584C-25B8-4BD7-A71D-7625FDC1ACD6"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1300731000000106","display":"COVID-19 confirmed using clinical diagnostic criteria"}]},"encounter":{"reference":"Encounter/13DDB7F7-EF7A-4825-B0A1-B17B7B4DE942"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/C8A2E6BA-4304-4428-A97D-AF4009ABBE91","resource":{"resourceType":"Practitioner","id":"C8A2E6BA-4304-4428-A97D-AF4009ABBE91","name":[{"text":"William Jones"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/E3FE00AE-40E8-43D8-8779-13E24C1E2ACB","resource":{"resourceType":"PractitionerRole","id":"E3FE00AE-40E8-43D8-8779-13E24C1E2ACB","practitioner":{"reference":"Practitioner/C8A2E6BA-4304-4428-A97D-AF4009ABBE91"},"organization":{"reference":"Organization/C952E630-7934-4C18-A670-235E5A7F0802"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0010","display":"Medical Director"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/C952E630-7934-4C18-A670-235E5A7F0802","resource":{"resourceType":"Organization","id":"C952E630-7934-4C18-A670-235E5A7F0802","type":[{"coding":[{"code":"021"}]}],"name":"Good Health Hospital","telecom":[{"system":"phone","value":"0122865579"},{"system":"pager","value":"0189664144"}],"address":[{"text":"ORG ADDRESS_2"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/24362D88-A6AB-4DDA-94E6-97BB5B0A27AE","resource":{"resourceType":"PractitionerRole","id":"24362D88-A6AB-4DDA-94E6-97BB5B0A27AE","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"578934433"}],"practitioner":{"reference":"Practitioner/0DDEE68F-4A92-4ECF-8B25-B83C5D1C0C68"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/0DDEE68F-4A92-4ECF-8B25-B83C5D1C0C68","resource":{"resourceType":"Practitioner","id":"0DDEE68F-4A92-4ECF-8B25-B83C5D1C0C68","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"9054354543"}],"name":[{"text":"Anna Maria"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/13DDB7F7-EF7A-4825-B0A1-B17B7B4DE942","resource":{"resourceType":"Encounter","id":"13DDB7F7-EF7A-4825-B0A1-B17B7B4DE942","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-12-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/E3FE00AE-40E8-43D8-8779-13E24C1E2ACB"}},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"INF","display":"informant"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/24362D88-A6AB-4DDA-94E6-97BB5B0A27AE"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/8CEB2867-551B-43D0-88B5-3278DA20A6B0","resource":{"resourceType":"Condition","id":"8CEB2867-551B-43D0-88B5-3278DA20A6B0","identifier":[{"value":"8CEB2867-551B-43D0-88B5-3278DA20A6B0"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240761000000102","display":"Suspected COVID-19"}]},"encounter":{"reference":"Encounter/330A104F-F328-4A65-A0B8-DEEC91A0E262"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/BDDA65CD-2DB8-44D1-B289-B0BA1182FA21","resource":{"resourceType":"Practitioner","id":"BDDA65CD-2DB8-44D1-B289-B0BA1182FA21","name":[{"text":"Stephan Spence"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/E5E45994-E9A4-4BAB-A4B2-DCA8AF1B6493","resource":{"resourceType":"PractitionerRole","id":"E5E45994-E9A4-4BAB-A4B2-DCA8AF1B6493","practitioner":{"reference":"Practitioner/BDDA65CD-2DB8-44D1-B289-B0BA1182FA21"},"organization":{"reference":"Organization/92CB3A00-A4E2-485F-8671-6E2E499536DB"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0020","display":"Clinical Director - Medical"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/92CB3A00-A4E2-485F-8671-6E2E499536DB","resource":{"resourceType":"Organization","id":"92CB3A00-A4E2-485F-8671-6E2E499536DB","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"57435939053"}],"name":"Good Health Hospital 2","telecom":[{"system":"phone","value":"0122865579"},{"system":"pager","value":"0189664144"}],"address":[{"text":"ORG ADDRESS_2"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/RelatedPerson/B0A64A15-3552-4525-8305-1DBFDF548C97","resource":{"resourceType":"RelatedPerson","id":"B0A64A15-3552-4525-8305-1DBFDF548C97","patient":{"reference":"Patient/565B3BEF-9A19-4763-8887-9F7CB75995E3"},"relationship":[{"coding":[{"system":"https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1","code":"01","display":"Brother"}]}],"name":[{"text":"JONES Bob"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/330A104F-F328-4A65-A0B8-DEEC91A0E262","resource":{"resourceType":"Encounter","id":"330A104F-F328-4A65-A0B8-DEEC91A0E262","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-12-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/E5E45994-E9A4-4BAB-A4B2-DCA8AF1B6493"}},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"INF","display":"informant"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"RelatedPerson/B0A64A15-3552-4525-8305-1DBFDF548C97"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70","resource":{"resourceType":"Condition","id":"6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70","identifier":[{"value":"6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240761000000102","display":"Suspected COVID-19"}]},"encounter":{"reference":"Encounter/0EB8181D-2CCB-444D-826F-9F0B05698730"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/EDF20F0A-E2B9-4077-9EC8-89B4A1D6ABEF","resource":{"resourceType":"Practitioner","id":"EDF20F0A-E2B9-4077-9EC8-89B4A1D6ABEF","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"8563857943834"}],"name":[{"text":"Gregory House"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/528485E6-E9F6-4F6C-8603-5C4688AC3E4D","resource":{"resourceType":"PractitionerRole","id":"528485E6-E9F6-4F6C-8603-5C4688AC3E4D","practitioner":{"reference":"Practitioner/EDF20F0A-E2B9-4077-9EC8-89B4A1D6ABEF"},"organization":{"reference":"Organization/82896F68-1EC4-48ED-AC9C-31219BE48D1C"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0080","display":"Staff Grade"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/82896F68-1EC4-48ED-AC9C-31219BE48D1C","resource":{"resourceType":"Organization","id":"82896F68-1EC4-48ED-AC9C-31219BE48D1C","telecom":[{"system":"phone","value":"0332865579"}],"address":[{"text":"ORG ADDRESS_4"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/62E22530-06D0-4622-84B8-46BE42E51467","resource":{"resourceType":"Practitioner","id":"62E22530-06D0-4622-84B8-46BE42E51467","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"564735334"}],"name":[{"text":"Thomas Moore"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/2EAC367D-5C65-4564-8475-D62C44B21A02","resource":{"resourceType":"PractitionerRole","id":"2EAC367D-5C65-4564-8475-D62C44B21A02","practitioner":{"reference":"Practitioner/62E22530-06D0-4622-84B8-46BE42E51467"},"organization":{"reference":"Organization/5BF9CD67-5A0D-43AF-B654-E0F85D2B5FDA"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0100","display":"Clinical Assistant"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/5BF9CD67-5A0D-43AF-B654-E0F85D2B5FDA","resource":{"resourceType":"Organization","id":"5BF9CD67-5A0D-43AF-B654-E0F85D2B5FDA","telecom":[{"system":"phone","value":"573459834"}],"address":[{"text":"ORG ADDRESS_4"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/0EB8181D-2CCB-444D-826F-9F0B05698730","resource":{"resourceType":"Encounter","id":"0EB8181D-2CCB-444D-826F-9F0B05698730","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-12-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/528485E6-E9F6-4F6C-8603-5C4688AC3E4D"}},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"INF","display":"informant"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/2EAC367D-5C65-4564-8475-D62C44B21A02"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/839ABFE3-1063-4B03-A716-E67377417F9B","resource":{"resourceType":"PractitionerRole","id":"839ABFE3-1063-4B03-A716-E67377417F9B","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"89823498234"}],"practitioner":{"reference":"Practitioner/53A9AEDB-5497-413B-B272-F1C51771A55D"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/53A9AEDB-5497-413B-B272-F1C51771A55D","resource":{"resourceType":"Practitioner","id":"53A9AEDB-5497-413B-B272-F1C51771A55D","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"9699575667"}],"name":[{"text":"Maria Smith"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/74852157-6F69-497F-8116-7E2F4493999A","resource":{"resourceType":"Encounter","id":"74852157-6F69-497F-8116-7E2F4493999A","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"extension":[{"url":"https://fhir.nhs.uk/StructureDefinition/Extension-SCR-ModeCode","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationMode","code":"PHYSICAL","display":"physical presence"}]}}],"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"PRF","display":"performer"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/839ABFE3-1063-4B03-A716-E67377417F9B"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49","resource":{"resourceType":"Observation","id":"F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"]},"identifier":[{"value":"F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49"}],"status":"final","category":[{"coding":[{"system":"http://snomed.info/sct","code":"163141000000104","display":"Investigation Results"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240581000000104","display":"SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"}]},"encounter":{"reference":"Encounter/74852157-6F69-497F-8116-7E2F4493999A"},"effectivePeriod":{"start":"2020-05-06T12:48:19+00:00"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Device/4FCE15F1-6969-41BD-9298-BE595CB6E995","resource":{"resourceType":"Device","id":"4FCE15F1-6969-41BD-9298-BE595CB6E995","identifier":[{"system":"https://fhir.nhs.uk/Id/SDSDevice","value":"930484003023"},{"value":"AAA5F1E0-6DF2-11EA-AE26-C5CB3G0B33D1"}],"owner":{"reference":"Organization/F806387E-824C-4931-8ABF-DE7A545046C1"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/F806387E-824C-4931-8ABF-DE7A545046C1","resource":{"resourceType":"Organization","id":"F806387E-824C-4931-8ABF-DE7A545046C1","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"7635043534"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/3AA33898-49AB-41FC-9805-E30031DFB37D","resource":{"resourceType":"PractitionerRole","id":"3AA33898-49AB-41FC-9805-E30031DFB37D","organization":{"reference":"Organization/F806387E-824C-4931-8ABF-DE7A545046C1"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/54096A6E-03C3-48B8-B448-7C813EC926DA","resource":{"resourceType":"Encounter","id":"54096A6E-03C3-48B8-B448-7C813EC926DA","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/3AA33898-49AB-41FC-9805-E30031DFB37D"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0","resource":{"resourceType":"Observation","id":"EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"]},"identifier":[{"value":"EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0"}],"status":"final","category":[{"coding":[{"system":"http://snomed.info/sct","code":"163141000000104","display":"Investigation Results"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240581000000104","display":"SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"}]},"encounter":{"reference":"Encounter/54096A6E-03C3-48B8-B448-7C813EC926DA"},"effectivePeriod":{"start":"2020-05-06T12:48:19+00:00"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Device/C21F61F0-B9CB-49A3-A966-9BFC4ED2FBEC","resource":{"resourceType":"Device","id":"C21F61F0-B9CB-49A3-A966-9BFC4ED2FBEC","identifier":[{"value":"7867868687687"},{"value":"AAA5F1E0-6DF2-11EA-AE26-C5CB3F0B33D1"}],"deviceName":[{"name":"Some device name","type":"other"},{"name":"Mfc model name","type":"manufacturer-name"}],"type":{"coding":[{"code":"01","display":"Some device"}]},"version":[{"value":"v.1.10.245-beta"}],"owner":{"reference":"Organization/8D1D94AB-26D3-4A1F-BC22-A02670BCB444"},"note":[{"text":"Device description"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/8D1D94AB-26D3-4A1F-BC22-A02670BCB444","resource":{"resourceType":"Organization","id":"8D1D94AB-26D3-4A1F-BC22-A02670BCB444","type":[{"coding":[{"code":"214"}]}],"name":"Device owner org","telecom":[{"system":"phone","value":"fax:01392251689"}],"address":[{"text":"ADDRESS LINE 1"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/29BF2890-7D56-4FC5-A3A9-7D3483205EFD","resource":{"resourceType":"PractitionerRole","id":"29BF2890-7D56-4FC5-A3A9-7D3483205EFD","organization":{"reference":"Organization/8D1D94AB-26D3-4A1F-BC22-A02670BCB444"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/863E4623-2F33-45C5-B02F-26BBAEDE24E8","resource":{"resourceType":"Encounter","id":"863E4623-2F33-45C5-B02F-26BBAEDE24E8","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/29BF2890-7D56-4FC5-A3A9-7D3483205EFD"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/0F582D97-8F89-11CA-8B2D-B741F13EFC47","resource":{"resourceType":"Observation","id":"0F582D97-8F89-11CA-8B2D-B741F13EFC47","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"]},"identifier":[{"value":"0F582D97-8F89-11CA-8B2D-B741F13EFC47"}],"status":"final","category":[{"coding":[{"system":"http://snomed.info/sct","code":"163141000000104","display":"Investigation Results"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240581000000104","display":"SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"}]},"encounter":{"reference":"Encounter/863E4623-2F33-45C5-B02F-26BBAEDE24E8"},"effectivePeriod":{"start":"2020-05-06T12:48:19+00:00"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Patient/565B3BEF-9A19-4763-8887-9F7CB75995E3","resource":{"resourceType":"Patient","id":"565B3BEF-9A19-4763-8887-9F7CB75995E3","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}]}}]}}}}}},"responses":{"201":{"description":"SCR successfully uploaded"},"500":{"description":"Internal Server Error. A similar message could be triggered for 502 Bad Gateway or any other 5XX error. See the \"Errors\" section for more details.","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation error outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["error"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"unknown"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","default":"1"},"code":{"type":"string","example":"UNKNOWN_ERROR"},"display":{"type":"string","example":"Unknown Error"}}}}}},"diagnostics":{"type":"string","example":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})"}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"unknown","details":{"coding":{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":1,"code":"UNKNOWN_ERROR","display":"Unknown Error"}},"diagnostics":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: rrt-4161241190348351641-b-geu2-4210-928960-20)"}]}}}},"503":{"description":"Service unavailable. Response may be JSON as per example, or HTML message including the term \"503 Service Temporarily Unavailable\".","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"transient","details":{"text":"Code: 503, Display: Service Not Available"}}]}}}},"504":{"description":"The request timed out during processing. This does not imply the request has failed or been rejected.\nRe-send the request using the same `X-Request-ID` value. Wait 5 seconds before the first retried request.\nWhere multiple retries are necessary, adopt an exponential back-off approach.\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"transient","details":{"text":"Request processing timed out. Spine POST + polling GET has timed out"}}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Issue severity | Issue code | Description |\n| ----------- | -------------- | ------------- | --------------------------------------------- |\n| 400 | error | invalid | Bad request, error in business logic on the client's side |\n| 401 | error | forbidden | Unauthorized, access token missing, invalid or expired |\n| 403 | error | forbidden | There's no patient's consent to store SCR |\n| 413 | error | invalid | Content too large, request was larger than the server was able to handle. This is a host imposed limitation/error. |\n| 415 | error | not-supported | Unsupported Media Type, Content-Type header is invalid or missing. The following header should be sent with the request: `Content-Type: application/fhir+json` |\n| 429 | error | - | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"text":"[PSIS-30134] - Duplicate event with eventId FFFBB3CF-62F3-11EC-BCD6-024734D13536 and nhsNumber 9111231130."}}]}}}}}},"get":{"description":"## Overview\nUse this endpoint to retrieve the details of a patient's most recent Summary Care Record.\n\nYou must specify the NHS number and the UUID of the latest Summary Care Record of this patient. This UUID should be obtained using the GET /DocumentReference endpoint.\n\nIf you specify an out-of-date UUID, this endpoint returns a Bundle with 0 entries.\n\n## Usage diagram\n\n![GET SCR Diagram](https://raw.githubusercontent.com/NHSDigital/summary-care-record-api/various-documentation-changes/specification/components/resources/images/diagram-2.jpg)\n\n## Sandbox test scenarios\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------|---------------------------------- |\n| Happy path | `composition.identifier`=`FA60BE64-1F34-11EB-A2A8-000C29A364EB` `composition.subject:Patient.identifier`=`9000000009` | HTTP Status 200 - Full Bundle |\n| No results | `composition.identifier`=`81CC2DA0-8882-11EB-B538-0800200C9A66` `composition.subject:Patient.identifier`=`9000000033` | HTTP Status 200 - Empty Bundle |\n| Invalid results | `composition.identifier`=`INVALID ID` `composition.subject:Patient.identifier`=`INVALID NHS NUMBER` | HTTP Status 400 - Invalid Request |\n","summary":"Get patient's Summary Care Record","operationId":"get-scr","parameters":[{"in":"header","name":"Authorization","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},{"in":"header","name":"X-Correlation-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.\n\nWhen contacting the helpdesk and asking them to trace logs in Splunk, please supply the X-Correlation-ID (GIUD) from the request you are attempting to debug.\n\nMirrored back in a response header.\n\nAvoid `.` characters.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\nIf you re-send a failed request, use the same value in this header.\nMirrored back in a response header.\n","schema":{"type":"string","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"}},{"in":"query","name":"composition.identifier","description":"Latest Patient's Summary Care Record identifier. Can be obtained using GET /DocumentReference endpoint.","example":"FA60BE64-1F34-11EB-A2A8-000C29A364EB","required":true,"schema":{"type":"string"}},{"in":"query","name":"composition.subject:Patient.identifier","description":"The patient's NHS number. Must be preceded with FHIR identifier (eg.\"composition.subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009\")","example":"https://fhir.nhs.uk/Id/nhs-number|9000000009","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SCR successfully returned","content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","default":"Bundle"},"id":{"type":"string","example":"CE6B1A4F-51A4-4E03-AAB3-BA6113888E9F"},"identifier":{"type":"object","properties":{"system":{"type":"string","default":"https://tools.ietf.org/html/rfc4122"},"value":{"type":"string","example":"10C71ECE-08F8-41D8-8A39-45D42DFC61D4"}}},"type":{"description":"type of the Bundle","type":"string","default":"searchset"},"timestamp":{"type":"string","example":"2007-03-15T01:00:00+00:00"},"total":{"type":"integer","example":58,"description":"Total number of entries in the Bundle"},"entry":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Composition/25FCE159-C82D-482B-8EA9-86DEF2C3929B"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Composition"},"id":{"type":"string","example":"25FCE159-C82D-482B-8EA9-86DEF2C3929B"},"meta":{"type":"object","properties":{"lastUpdated":{"type":"string","example":"2020-11-17T01:00:00+00:00"}},"required":["lastUpdated"]},"identifier":{"type":"object","properties":{"system":{"type":"string","default":"https://tools.ietf.org/html/rfc4122"},"value":{"type":"string","example":"C058D90F-E526-4A27-A46E-E86229096AAC"}},"required":["system","value"]},"status":{"type":"string","default":"final"},"type":{"description":"Kind of composition","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","default":"196981000000101"},"display":{"type":"string","default":"General Practice Summary"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","default":"163171000000105"},"display":{"type":"string","default":"Care Professional Documentation"}},"required":["system","code","display"]}}},"required":["coding"]}},"subject":{"description":"Who and/or what the composition is about","type":"object","properties":{"reference":{"type":"string","example":"Patient/B61AF2BD-0FFD-49CC-8374-C70DAFF8878F"}},"required":["reference"]},"date":{"type":"string","example":"2007-03-15T01:00:00+00:00"},"author":{"type":"array","items":{"description":"Who and/or what authored the composition.","type":"object","properties":{"reference":{"type":"string","example":"PractitionerRole/33661E10-AA36-491A-AFFE-5C10C0BF9304"},"display":{"type":"string","example":"Dr Mark Spencer"}},"required":["reference"]},"minItems":1},"title":{"description":"Human Readable name/title","type":"string","example":"General Practice Summary"},"relatesTo":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"replaces"},"targetIdentifier":{"type":"object","properties":{"value":{"type":"string","example":"D18B57ED-992E-45A2-A6AF-55200D20F48E"}}}}}},"section":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","example":"Allergies and Adverse Reactions"},"text":{"type":"object","properties":{"status":{"type":"string","example":"generated"},"div":{"type":"string","example":"
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DateDescriptionCertaintySeveritySupporting Information
12-May-2020Toxic reaction to wasp sting\n \n Problem; First
\n
"}}}}}}},"required":["resourceType","meta","identifier","status","type","category","subject","date","title"]}}},{"type":"object","properties":{"fullUrl":{"description":"UUID identifying resource within a bundle","type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Patient/453863C3-C679-4D84-9E01-1B1D0239AC5F"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Patient"},"id":{"type":"string","example":"453863C3-C679-4D84-9E01-1B1D0239AC5F"},"identifier":{"type":"array","items":{"type":"object","properties":{"extension":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1"},"valueCodeableConcept":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1"},"code":{"type":"string","example":"01"},"display":{"type":"string","example":"Number present and verified"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]}},"required":["url","valueCodeableConcept"]},"minItems":1,"maxItems":1},"system":{"type":"string","default":"https://fhir.nhs.uk/Id/nhs-number"},"value":{"type":"string","example":"9000000009"}},"required":["extension","system","value"]}}},"required":["resourceType","identifier"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Practitioner"},"id":{"type":"string","example":"F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD"},"identifier":{"type":"array","description":"There should be one identifier if user is a SDS USer","items":{"type":"object","properties":{"system":{"description":"Should be fixed to https://fhir.nhs.uk/Id/sds-user-id when user is a SDS user","type":"string","default":"https://fhir.nhs.uk/Id/sds-user-id"},"value":{"type":"string","description":"Filed mandatory when user is a SDS User","example":"676789689789"}},"required":["system","value"]}},"name":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"Mr. John Smith"}}}}},"required":["resourceType"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/FE7B9F77-3BC9-4D99-84DC-292D0762183C"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"PractitionerRole","description":"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."},"id":{"type":"string","example":"FE7B9F77-3BC9-4D99-84DC-292D0762183C"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://fhir.nhs.net/Id/sds-role-profile-id"},"value":{"type":"string","example":"673836492727"}},"required":["system","value"]}},"practitioner":{"type":"object","properties":{"reference":{"type":"string","example":"Practitioner/F4D5093D-351E-4C6E-819E-DCCBC4B9A7FD"}}},"organization":{"type":"object","properties":{"reference":{"type":"string","example":"Organization/90588362-F342-423F-AB6F-B5E92B20C6B6"}}},"code":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName"},"code":{"type":"string","example":"R0070"},"display":{"type":"string","example":"Associate Specialist"}}}}}}}},"required":["resourceType","identifier"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/ADB4683E-BE01-4B08-AE36-079837BFF19E"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Condition"},"id":{"type":"string","example":"ADB4683E-BE01-4B08-AE36-079837BFF19E"},"meta":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string","default":"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"}}}},"identifier":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"0F582D97-8F89-11EA-8B2D-B741F13EFC47"}},"required":["value"]},"minItems":1,"maxItems":1},"clinicalStatus":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://terminology.hl7.org/CodeSystem/condition-clinical"},"code":{"type":"string","example":"active"},"display":{"type":"string","example":"Active"}},"required":["system","code"]},"minItems":1,"maxItems":1}}},"maxItems":1},"verificationStatus":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://hl7.org/fhir/ValueSet/condition-ver-status"},"code":{"type":"string","example":"confirmed"},"display":{"type":"string","example":"Confirmed"}},"required":["system","code"]},"minItems":1,"maxItems":1}}},"maxItems":1},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","example":"163001000000103"},"display":{"type":"string","example":"Diagnoses"}},"required":["system","code","display"]}},"required":["coding"]},"minItems":1,"maxItems":1},"code":{"description":"Following SNOMED CT concept IDs are supported [(see more)](https://digital.nhs.uk/services/summary-care-records-scr/coronavirus-covid-19-message-in-scr):\n* 1240751000000100 COVID-19\n* 1240761000000102 COVID-19 confirmed by laboratory test\n* 1300731000000106 COVID-19 confirmed using clinical diagnostic criteria\n* 1300721000000109 Suspected COVID-19\n","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"http://snomed.info/sct"},"code":{"type":"string","example":"1240631000000102"},"display":{"type":"string","example":"Did not attend SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]},"onsetDateTime":{"type":"string","example":"2020-05-06T10:48:19+00:00"},"evidence":{"description":"Supporting evidence - should link Observation resource","type":"array","items":{"type":"object","properties":{"detail":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string","example":"Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49","description":"Reference to related Observation resource"}},"required":["reference"]}}},"required":["detail"]},"minItems":1},"note":{"description":"Additional information about the Condition","type":"array","items":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]},"minItems":1,"maxItems":1}},"required":["resourceType","identifier","status","category","code"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/6E1B91CC-C25A-4466-94A6-DFDE260C12AB"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Encounter"},"id":{"type":"string","example":"6E1B91CC-C25A-4466-94A6-DFDE260C12AB"},"status":{"type":"string","default":"finished"},"class":{"type":"object","properties":{"system":{"type":"string","default":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor"},"code":{"type":"string","default":"UNK"},"display":{"type":"string","default":"Unknown"}}},"participant":{"type":"array","items":{"type":"object","properties":{"type":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType"},"code":{"type":"string","enum":["AUT","PRF","INF"],"example":"AUT"},"display":{"type":"string","example":"author"}},"required":["system","code"]},"minItems":1,"maxItems":1}}},"minItems":1,"maxItems":1},"period":{"type":"object","properties":{"start":{"type":"string","example":"2020-11-17T01:00:00+00:00"}},"required":["start"]},"individual":{"type":"object","properties":{"reference":{"type":"string","example":"PractitionerRole/1CB6874C-67C4-4A3B-BE24-3D574382D464"}},"required":["reference"]}},"required":["type","period","individual"]}}}}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/FD3F2E98-511F-4A3E-AD84-127DAEC1645E"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Organization"},"id":{"type":"string","example":"FD3F2E98-511F-4A3E-AD84-127DAEC1645E"},"identifier":{"description":"Organization identifier. Mandatory for SDS organizations.","type":"array","items":{"type":"object","properties":{"use":{"type":"string","example":"official"},"system":{"type":"string","default":"https://fhir.nhs.uk/Id/ods-organization-code"},"value":{"type":"string","example":"RR8"}}}},"type":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"021"}}}}}}},"name":{"type":"string","example":"LEEDS TEACHING HOSPITAL TRUST"},"telecom":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"phone"},"value":{"type":"string","example":"0113 243 3144"}}}},"address":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}}},"required":["resourceType"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/RelatedPerson/086DE219-FEDF-41D4-BA5D-55EE3B1CAE9F"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"RelatedPerson"},"id":{"type":"string","example":"086DE219-FEDF-41D4-BA5D-55EE3B1CAE9F"},"relationship":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1"},"code":{"type":"string","example":"01"},"display":{"type":"string","example":"Brother"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}},"required":["coding"]},"minItems":1,"maxItems":1},"name":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"Mr. John Smith"}}}}},"required":["resourceType","relationship","name"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/02778CD7-E78E-4BF5-9B05-1C634275DB91"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Observation"},"id":{"type":"string","example":"02778CD7-E78E-4BF5-9B05-1C634275DB91"},"meta":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string","default":"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"}}},"minItems":1,"maxItems":1},"identifier":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","example":"0F582D97-8F89-11EA-8B2D-B741F13EFC47"}},"required":["value"]},"minItems":1,"maxItems":1},"status":{"type":"string","enum":["final","entered-in-error"],"example":"final"},"category":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","example":"163001000000104"},"display":{"type":"string","example":"Investigation Results"}},"required":["system","code"]}},"required":["coding"]},"minItems":1,"maxItems":1},"code":{"description":"Following SNOMED CT concept IDs are supported [(see more)](https://digital.nhs.uk/services/summary-care-records-scr/coronavirus-covid-19-message-in-scr):\n* 1240581000000104 SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive\n","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"http://snomed.info/sct"},"code":{"type":"string","example":"1240631000000102"},"display":{"type":"string","example":"Did not attend SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination"}},"required":["system","code","display"]}}},"required":["coding"]},"effectivePeriod":{"type":"object","properties":{"start":{"type":"string","example":"2020-05-06T10:48:19+00:00"},"end":{"type":"string","example":"2020-05-26T11:56:18+00:00"}}}},"required":["resourceType","identifier","status","category","code"]}}},{"type":"object","properties":{"fullUrl":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Device/C5F6616C-AA6F-4A8C-85FF-0183C3D15D37"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Device"},"id":{"type":"string","example":"C5F6616C-AA6F-4A8C-85FF-0183C3D15D37"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.nhs.uk/Id/SDSDevice"},"value":{"type":"string","example":"7867868687687"}},"required":["value"]},"minItems":1},"deviceName":{"description":"The name of the device as given by the manufacturer","type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"other"},"type":{"type":"string","example":"manufacturer-name"}}}},"type":{"description":"The kind or type of device. Field is mandatory when device is NOT a SDS Device.","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"707728009"},"display":{"type":"string","example":"Device system"}},"required":["code","display"]}}},"required":["coding"]},"version":{"description":"The actual design of the device or software version running on the device","type":"object","properties":{"value":{"type":"string","example":"1.0.0"}}},"owner":{"description":"Organization responsible for device","type":"object","properties":{"reference":{"type":"string","example":"Organization/2FF8C5EC-E517-421A-B4A4-D7EAAA1EFE12"}}},"note":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"Additional information"}}}}},"required":["resourceType"]}}}]}}},"required":["resourceType","timestamp","identifier","entry"]},"examples":{"Example JSON SCR Bundle":{"summary":"Example SCR Bundle","value":{"resourceType":"Bundle","id":"D5537E37-FFC6-4E7B-9BC4-336E871C0F29","identifier":{"system":"https://tools.ietf.org/html/rfc4122","value":"821533D3-3E0F-11EB-8111-F40343488B16"},"type":"searchset","timestamp":"2020-12-14T13:23:10+00:00","total":48,"entry":[{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Composition/BF4180FD-C403-4EF7-A4AB-E07303AF5477","resource":{"resourceType":"Composition","id":"BF4180FD-C403-4EF7-A4AB-E07303AF5477","meta":{"lastUpdated":"2020-11-17T01:00:00+00:00"},"identifier":{"system":"https://tools.ietf.org/html/rfc4122","value":"BF4180FD-C403-4EF7-A4AB-E07303AF5477"},"status":"final","type":{"coding":[{"system":"http://snomed.info/sct","code":"196981000000101","display":"General Practice Summary"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163171000000105","display":"Care Professional Documentation"}]}],"subject":{"reference":"Patient/01F9B243-02DC-42F4-8F51-2AF2A99DA377"},"date":"2020-11-17T01:00:00+00:00","author":[{"reference":"PractitionerRole/D29F2286-A962-4034-B7D4-32CCB3610204"}],"relatesTo":[{"code":"replaces","targetIdentifier":{"value":"D18B57ED-992E-45A2-A6AF-55200D20F48E"}}],"section":[{"title":"General Practice Summary","code":{"coding":[{"code":"Title"}]},"text":{"status":"generated","div":"

Sourced from the patient's General Practice record. This summary may not include all the information pertinent to this patient.

Summary Created: 14-May-2020 14:31

At the time this record was created, this patient had recently registered with the GP Practice. GP Summary information may not be complete.

Created by: SMITH, Sean (Mr)

EMISWebCR1 50004, Fulford Grange, Rawdon, Leeds, West Yorkshire, LS19 7BY.

"}},{"title":"Allergies and Adverse Reactions","code":{"coding":[{"code":"AllergiesHeader"}]},"text":{"status":"generated","div":"
DateDescriptionCertaintySeveritySupporting Information
12-May-2020Toxic reaction to wasp stingProblem; First
"}},{"title":"Acute Medications (For the 12 month period 14-May-2019 to 14-May-2020)","code":{"coding":[{"code":"AcuteMedsHeader"}]},"text":{"status":"generated","div":"
TypeDateMedication ItemDosage InstructionsQuantity
Acute MedicationPrescribed: 12-May-2020Co-codamol 8mg/500mg effervescent tabletsOne To Be Taken Four Times A Day112 tablet
"}},{"title":"Current Repeat Medications","code":{"coding":[{"code":"RepeatMedsHeader"}]},"text":{"status":"generated","div":"
TypeDateMedication ItemDosage InstructionsQuantity
Repeat MedicationLast Issued: 12-May-2020Paracetamol 250mg/5ml oral suspensionOne 5ml Spoonful Every 4 To 6 Hours When Necessary. No More Than 4 doses in 24 Hours40 ml
"}},{"title":"Discontinued Repeat Medications (For the 6 month period 14-Nov-2019 to 14-May-2020)","code":{"coding":[{"code":"DiscRepeatMedsHeader"}]},"text":{"status":"generated","div":"
TypeDateMedication ItemDosage InstructionsQuantity
No relevant information available for this category.
"}},{"title":"Risks to Patient","code":{"coding":[{"code":"RisksToPatientHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
14-May-2020Low risk category for developing complication from COVID-19 infectionProblem; Review
"}},{"title":"Diagnoses","code":{"coding":[{"code":"DiagnosesHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
13-May-2020COVID-19 confirmed by laboratory testProblem; First, test
"},"entry":[{"reference":"Condition/FCB84E15-02E5-495C-B334-D0685DCB0687"},{"reference":"Condition/0F582D97-8F89-11EA-8B2D-B741F13EFC47"},{"reference":"Condition/958E584C-25B8-4BD7-A71D-7625FDC1ACD6"},{"reference":"Condition/8CEB2867-551B-43D0-88B5-3278DA20A6B0"},{"reference":"Condition/6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70"}]},{"title":"Problems and Issues","code":{"coding":[{"code":"ProblemsHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
14-May-20202019-nCoV (novel coronavirus) detectedSignificant Active
"}},{"title":"Clinical Observations and Findings","code":{"coding":[{"code":"ObservationsHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
14-May-20202019-nCoV (novel coronavirus) detectedProblem; New
"}},{"title":"Treatments","code":{"coding":[{"code":"TreatmentsHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
13-May-20202019-nCoV (novel coronavirus) vaccinationProblem; First, Manufacturer: jh, Expiry Date: 29-May-2020, Batch Number: 2, GMS: GMS, Injection site: Left arm, test
"}},{"title":"Investigation Results","code":{"coding":[{"code":"ResultsHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
13-May-2020Assessment using COVID-19 severity scaleProblem; First, test
"},"entry":[{"reference":"Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49"},{"reference":"Observation/EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0"},{"reference":"Observation/0F582D97-8F89-11CA-8B2D-B741F13EFC47"}]},{"title":"Care Events","code":{"coding":[{"code":"EventsHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
13-May-2020Did not attend 2019-nCoV (novel coronavirus) vaccinationProblem; First, test
"}},{"title":"Administrative Procedures","code":{"coding":[{"code":"ProceduresHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
14-May-2020Household isolation note issued to patientTest
"}},{"title":"Provision of Advice and Information to Patients and Carers","code":{"coding":[{"code":"AdviceHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
13-May-2020Advice given about SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) by telephoneProblem; First, test
"}},{"title":"Personal Preferences","code":{"coding":[{"code":"PreferencesHeader"}]},"text":{"status":"generated","div":"
DateDescriptionAdditional information
13-May-20202019-nCoV (novel coronavirus) vaccination declinedProblem; First, test

Summary Sent: 14-May-2020 14:31

"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/D29F2286-A962-4034-B7D4-32CCB3610204","resource":{"resourceType":"PractitionerRole","id":"D29F2286-A962-4034-B7D4-32CCB3610204","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"673836492727"}],"practitioner":{"reference":"Practitioner/EC705629-5B5D-4A5A-8692-2096C0B29D46"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/EC705629-5B5D-4A5A-8692-2096C0B29D46","resource":{"resourceType":"Practitioner","id":"EC705629-5B5D-4A5A-8692-2096C0B29D46","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"676789689789"}],"name":[{"text":"Dr Steve Jones"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/FCB84E15-02E5-495C-B334-D0685DCB0687","resource":{"resourceType":"Condition","id":"FCB84E15-02E5-495C-B334-D0685DCB0687","identifier":[{"value":"FCB84E15-02E5-495C-B334-D0685DCB0687"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240751000000100","display":"COVID-19"}]},"encounter":{"reference":"Encounter/C8219745-04B8-4181-9654-364BB3E64247"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/B98F04AA-B24C-4736-A753-81641EDE2D05","resource":{"resourceType":"PractitionerRole","id":"B98F04AA-B24C-4736-A753-81641EDE2D05","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"673836492727"}],"practitioner":{"reference":"Practitioner/443399A2-2C90-4B78-BD17-53424E3A52AB"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/443399A2-2C90-4B78-BD17-53424E3A52AB","resource":{"resourceType":"Practitioner","id":"443399A2-2C90-4B78-BD17-53424E3A52AB","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"676789689789"}],"name":[{"text":"Dr Steve Jones"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/C8219745-04B8-4181-9654-364BB3E64247","resource":{"resourceType":"Encounter","id":"C8219745-04B8-4181-9654-364BB3E64247","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-11-17T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/B98F04AA-B24C-4736-A753-81641EDE2D05"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/0F582D97-8F89-11EA-8B2D-B741F13EFC47","resource":{"resourceType":"Condition","id":"0F582D97-8F89-11EA-8B2D-B741F13EFC47","identifier":[{"value":"0F582D97-8F89-11EA-8B2D-B741F13EFC47"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1300721000000109","display":"COVID-19 confirmed by laboratory test"}]},"encounter":{"reference":"Encounter/EAA6B250-8998-4E60-BE82-6F9BA9929569"},"onsetDateTime":"2020-05-06T12:48:19+00:00","evidence":[{"detail":[{"reference":"Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49"}]}],"note":[{"text":"Problem; First, test"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/80BC96D3-4C5D-47A8-98D7-CD2D763C14E9","resource":{"resourceType":"Practitioner","id":"80BC96D3-4C5D-47A8-98D7-CD2D763C14E9","name":[{"text":"BLOGGS Fred"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/E8450CE2-2C49-4A09-9C74-01B23D71AEC1","resource":{"resourceType":"PractitionerRole","id":"E8450CE2-2C49-4A09-9C74-01B23D71AEC1","practitioner":{"reference":"Practitioner/80BC96D3-4C5D-47A8-98D7-CD2D763C14E9"},"organization":{"reference":"Organization/EC3EF53E-9272-495D-9FB3-BEF0CC92238A"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0050","display":"Consultant"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/EC3EF53E-9272-495D-9FB3-BEF0CC92238A","resource":{"resourceType":"Organization","id":"EC3EF53E-9272-495D-9FB3-BEF0CC92238A","telecom":[{"system":"phone","value":"0177865579"},{"system":"phone","value":"0189834144"}],"address":[{"text":"ORG ADDRESS"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/EAA6B250-8998-4E60-BE82-6F9BA9929569","resource":{"resourceType":"Encounter","id":"EAA6B250-8998-4E60-BE82-6F9BA9929569","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-11-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/E8450CE2-2C49-4A09-9C74-01B23D71AEC1"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/958E584C-25B8-4BD7-A71D-7625FDC1ACD6","resource":{"resourceType":"Condition","id":"958E584C-25B8-4BD7-A71D-7625FDC1ACD6","identifier":[{"value":"958E584C-25B8-4BD7-A71D-7625FDC1ACD6"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1300731000000106","display":"COVID-19 confirmed using clinical diagnostic criteria"}]},"encounter":{"reference":"Encounter/92BFA50F-9304-4002-997F-29512E7449C9"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/CA85E8B0-FE6A-4FB5-AA01-7D2615BC4C99","resource":{"resourceType":"Practitioner","id":"CA85E8B0-FE6A-4FB5-AA01-7D2615BC4C99","name":[{"text":"William Jones"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/2ECCB5AA-B14A-4B38-BD95-2B5FA08BCF11","resource":{"resourceType":"PractitionerRole","id":"2ECCB5AA-B14A-4B38-BD95-2B5FA08BCF11","practitioner":{"reference":"Practitioner/CA85E8B0-FE6A-4FB5-AA01-7D2615BC4C99"},"organization":{"reference":"Organization/FE4C3618-BBEC-421E-899B-D7175671DAA4"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0010","display":"Medical Director"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/FE4C3618-BBEC-421E-899B-D7175671DAA4","resource":{"resourceType":"Organization","id":"FE4C3618-BBEC-421E-899B-D7175671DAA4","type":[{"coding":[{"code":"021"}]}],"name":"Good Health Hospital","telecom":[{"system":"phone","value":"0122865579"},{"system":"pager","value":"0189664144"}],"address":[{"text":"ORG ADDRESS_2"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/1A4D4C00-6F32-49C6-A743-8C49454205D7","resource":{"resourceType":"PractitionerRole","id":"1A4D4C00-6F32-49C6-A743-8C49454205D7","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"578934433"}],"practitioner":{"reference":"Practitioner/85C61120-C263-403F-8400-9A287EDE3391"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/85C61120-C263-403F-8400-9A287EDE3391","resource":{"resourceType":"Practitioner","id":"85C61120-C263-403F-8400-9A287EDE3391","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"9054354543"}],"name":[{"text":"Anna Maria"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/92BFA50F-9304-4002-997F-29512E7449C9","resource":{"resourceType":"Encounter","id":"92BFA50F-9304-4002-997F-29512E7449C9","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-12-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/2ECCB5AA-B14A-4B38-BD95-2B5FA08BCF11"}},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"INF","display":"informant"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/1A4D4C00-6F32-49C6-A743-8C49454205D7"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/8CEB2867-551B-43D0-88B5-3278DA20A6B0","resource":{"resourceType":"Condition","id":"8CEB2867-551B-43D0-88B5-3278DA20A6B0","identifier":[{"value":"8CEB2867-551B-43D0-88B5-3278DA20A6B0"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240761000000102","display":"Suspected COVID-19"}]},"encounter":{"reference":"Encounter/B002BD59-3091-421C-A21E-02D96936466E"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/B9092541-D7A4-46E2-8AB8-03A5321A6B4B","resource":{"resourceType":"Practitioner","id":"B9092541-D7A4-46E2-8AB8-03A5321A6B4B","name":[{"text":"Stephan Spence"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/1A2AB8C9-D422-4755-8184-F19299EB413C","resource":{"resourceType":"PractitionerRole","id":"1A2AB8C9-D422-4755-8184-F19299EB413C","practitioner":{"reference":"Practitioner/B9092541-D7A4-46E2-8AB8-03A5321A6B4B"},"organization":{"reference":"Organization/00BFAB52-B403-424F-8504-DC5A1BF73D5D"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0020","display":"Clinical Director - Medical"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/00BFAB52-B403-424F-8504-DC5A1BF73D5D","resource":{"resourceType":"Organization","id":"00BFAB52-B403-424F-8504-DC5A1BF73D5D","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"57435939053"}],"name":"Good Health Hospital 2","telecom":[{"system":"phone","value":"0122865579"},{"system":"pager","value":"0189664144"}],"address":[{"text":"ORG ADDRESS_2"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/RelatedPerson/9DDB3E34-7BDB-437C-85D2-0C275DAA5068","resource":{"resourceType":"RelatedPerson","id":"9DDB3E34-7BDB-437C-85D2-0C275DAA5068","patient":{"reference":"Patient/01F9B243-02DC-42F4-8F51-2AF2A99DA377"},"relationship":[{"coding":[{"system":"https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1","code":"01","display":"Brother"}]}],"name":[{"text":"JONES Bob"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/B002BD59-3091-421C-A21E-02D96936466E","resource":{"resourceType":"Encounter","id":"B002BD59-3091-421C-A21E-02D96936466E","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-12-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/1A2AB8C9-D422-4755-8184-F19299EB413C"}},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"INF","display":"informant"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"RelatedPerson/9DDB3E34-7BDB-437C-85D2-0C275DAA5068"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Condition/6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70","resource":{"resourceType":"Condition","id":"6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70","identifier":[{"value":"6ECDAE6D-32AB-421C-AA8F-0B1ABA454C70"}],"clinicalStatus":{"coding":[{"system":"http://hl7.org/fhir/ValueSet/condition-clinical","code":"active"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"163001000000103","display":"Diagnoses"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240761000000102","display":"Suspected COVID-19"}]},"encounter":{"reference":"Encounter/69593A02-6072-4E1D-AF21-B0455703ED74"},"onsetDateTime":"2020-05-06T12:48:19+00:00"}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/AF1FE510-7F26-4EB0-B387-9CCA1FEA5CA1","resource":{"resourceType":"Practitioner","id":"AF1FE510-7F26-4EB0-B387-9CCA1FEA5CA1","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"8563857943834"}],"name":[{"text":"Gregory House"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/8CE425DE-D2C1-4D15-BF64-8D6E0F23BC2F","resource":{"resourceType":"PractitionerRole","id":"8CE425DE-D2C1-4D15-BF64-8D6E0F23BC2F","practitioner":{"reference":"Practitioner/AF1FE510-7F26-4EB0-B387-9CCA1FEA5CA1"},"organization":{"reference":"Organization/68A1EDD1-7A46-4428-AF7A-1B41D4FDE695"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0080","display":"Staff Grade"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/68A1EDD1-7A46-4428-AF7A-1B41D4FDE695","resource":{"resourceType":"Organization","id":"68A1EDD1-7A46-4428-AF7A-1B41D4FDE695","telecom":[{"system":"phone","value":"0332865579"}],"address":[{"text":"ORG ADDRESS_4"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/BD5016AA-674D-42FC-ABA2-346BFA928B1C","resource":{"resourceType":"Practitioner","id":"BD5016AA-674D-42FC-ABA2-346BFA928B1C","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"564735334"}],"name":[{"text":"Thomas Moore"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/9F426548-5AE6-4290-9DD2-CBD516283F18","resource":{"resourceType":"PractitionerRole","id":"9F426548-5AE6-4290-9DD2-CBD516283F18","practitioner":{"reference":"Practitioner/BD5016AA-674D-42FC-ABA2-346BFA928B1C"},"organization":{"reference":"Organization/EBECEBA8-6371-417B-8EC0-2478DCEA3886"},"code":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName","code":"R0100","display":"Clinical Assistant"}]}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/EBECEBA8-6371-417B-8EC0-2478DCEA3886","resource":{"resourceType":"Organization","id":"EBECEBA8-6371-417B-8EC0-2478DCEA3886","telecom":[{"system":"phone","value":"573459834"}],"address":[{"text":"ORG ADDRESS_4"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/69593A02-6072-4E1D-AF21-B0455703ED74","resource":{"resourceType":"Encounter","id":"69593A02-6072-4E1D-AF21-B0455703ED74","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2020-12-18T01:00:00+00:00"},"individual":{"reference":"PractitionerRole/8CE425DE-D2C1-4D15-BF64-8D6E0F23BC2F"}},{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"INF","display":"informant"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/9F426548-5AE6-4290-9DD2-CBD516283F18"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/DF33E1D2-D4AB-4435-9E79-0AEAC3017F22","resource":{"resourceType":"PractitionerRole","id":"DF33E1D2-D4AB-4435-9E79-0AEAC3017F22","identifier":[{"system":"http://fhir.nhs.net/Id/sds-role-profile-id","value":"89823498234"}],"practitioner":{"reference":"Practitioner/5B037394-2555-4B9B-87B3-117955219590"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Practitioner/5B037394-2555-4B9B-87B3-117955219590","resource":{"resourceType":"Practitioner","id":"5B037394-2555-4B9B-87B3-117955219590","identifier":[{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"9699575667"}],"name":[{"text":"Maria Smith"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/A171C6F3-45AB-4F8A-A458-5F0DF780D1B3","resource":{"resourceType":"Encounter","id":"A171C6F3-45AB-4F8A-A458-5F0DF780D1B3","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"extension":[{"url":"https://fhir.nhs.uk/StructureDefinition/Extension-SCR-ModeCode","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationMode","code":"PHYSICAL","display":"physical presence"}]}}],"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"PRF","display":"performer"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/DF33E1D2-D4AB-4435-9E79-0AEAC3017F22"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49","resource":{"resourceType":"Observation","id":"F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"]},"identifier":[{"value":"F17999D2-FFE7-4CA4-8CE8-52CB45FF6F49"}],"status":"final","category":[{"coding":[{"system":"http://snomed.info/sct","code":"163141000000104","display":"Investigation Results"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240581000000104","display":"SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"}]},"encounter":{"reference":"Encounter/A171C6F3-45AB-4F8A-A458-5F0DF780D1B3"},"effectivePeriod":{"start":"2020-05-06T12:48:19+00:00"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Device/03D1E382-8F3A-4792-BAC7-5F859B096EAD","resource":{"resourceType":"Device","id":"03D1E382-8F3A-4792-BAC7-5F859B096EAD","identifier":[{"system":"https://fhir.nhs.uk/Id/SDSDevice","value":"930484003023"},{"value":"AAA5F1E0-6DF2-11EA-AE26-C5CB3G0B33D1"}],"owner":{"reference":"Organization/4E9F538F-0412-402C-BD06-50FE140845C0"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/4E9F538F-0412-402C-BD06-50FE140845C0","resource":{"resourceType":"Organization","id":"4E9F538F-0412-402C-BD06-50FE140845C0","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"7635043534"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/28DBE1E2-102B-47AC-AA1D-6EAF5FBEB546","resource":{"resourceType":"PractitionerRole","id":"28DBE1E2-102B-47AC-AA1D-6EAF5FBEB546","organization":{"reference":"Organization/4E9F538F-0412-402C-BD06-50FE140845C0"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/CFBE18EF-CEBA-4735-AB4A-42456B1A1F2C","resource":{"resourceType":"Encounter","id":"CFBE18EF-CEBA-4735-AB4A-42456B1A1F2C","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/28DBE1E2-102B-47AC-AA1D-6EAF5FBEB546"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0","resource":{"resourceType":"Observation","id":"EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"]},"identifier":[{"value":"EE608FAA-2433-4BAD-A0D5-4A10E45AB2B0"}],"status":"final","category":[{"coding":[{"system":"http://snomed.info/sct","code":"163141000000104","display":"Investigation Results"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240581000000104","display":"SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"}]},"encounter":{"reference":"Encounter/CFBE18EF-CEBA-4735-AB4A-42456B1A1F2C"},"effectivePeriod":{"start":"2020-05-06T12:48:19+00:00"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Device/C63078DF-7F40-445F-908D-8864C442AC91","resource":{"resourceType":"Device","id":"C63078DF-7F40-445F-908D-8864C442AC91","identifier":[{"value":"7867868687687"},{"value":"AAA5F1E0-6DF2-11EA-AE26-C5CB3F0B33D1"}],"deviceName":[{"name":"Some device name","type":"other"},{"name":"Mfc model name","type":"manufacturer-name"}],"type":{"coding":[{"code":"01","display":"Some device"}]},"version":[{"value":"v.1.10.245-beta"}],"owner":{"reference":"Organization/3E39F48F-D122-4946-B7E1-B2C36D89A027"},"note":[{"text":"Device description"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Organization/3E39F48F-D122-4946-B7E1-B2C36D89A027","resource":{"resourceType":"Organization","id":"3E39F48F-D122-4946-B7E1-B2C36D89A027","type":[{"coding":[{"code":"214"}]}],"name":"Device owner org","telecom":[{"system":"phone","value":"fax:01392251689"}],"address":[{"text":"ADDRESS LINE 1"}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/PractitionerRole/DC41C785-56D6-45C6-94A0-3C5824E22EBE","resource":{"resourceType":"PractitionerRole","id":"DC41C785-56D6-45C6-94A0-3C5824E22EBE","organization":{"reference":"Organization/3E39F48F-D122-4946-B7E1-B2C36D89A027"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Encounter/18D17C94-3BBE-4DD5-ADDB-C67BADD37A1D","resource":{"resourceType":"Encounter","id":"18D17C94-3BBE-4DD5-ADDB-C67BADD37A1D","status":"finished","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-NullFlavor","code":"UNK","display":"Unknown"},"participant":[{"type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ParticipationType","code":"AUT","display":"author"}]}],"period":{"start":"2016-06-30T10:33:58+00:00"},"individual":{"reference":"PractitionerRole/DC41C785-56D6-45C6-94A0-3C5824E22EBE"}}]}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Observation/0F582D97-8F89-11CA-8B2D-B741F13EFC47","resource":{"resourceType":"Observation","id":"0F582D97-8F89-11CA-8B2D-B741F13EFC47","meta":{"profile":["https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"]},"identifier":[{"value":"0F582D97-8F89-11CA-8B2D-B741F13EFC47"}],"status":"final","category":[{"coding":[{"system":"http://snomed.info/sct","code":"163141000000104","display":"Investigation Results"}]}],"code":{"coding":[{"system":"http://snomed.info/sct","code":"1240581000000104","display":"SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"}]},"encounter":{"reference":"Encounter/18D17C94-3BBE-4DD5-ADDB-C67BADD37A1D"},"effectivePeriod":{"start":"2020-05-06T12:48:19+00:00"}}},{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Patient/01F9B243-02DC-42F4-8F51-2AF2A99DA377","resource":{"resourceType":"Patient","id":"01F9B243-02DC-42F4-8F51-2AF2A99DA377","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}]}}]}}}}}},"500":{"description":"Internal Server Error. A similar message could be triggered for 502 Bad Gateway or any other 5XX error. See the \"Errors\" section for more details.","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation error outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["error"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"unknown"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","default":"1"},"code":{"type":"string","example":"UNKNOWN_ERROR"},"display":{"type":"string","example":"Unknown Error"}}}}}},"diagnostics":{"type":"string","example":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})"}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"unknown","details":{"coding":{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":1,"code":"UNKNOWN_ERROR","display":"Unknown Error"}},"diagnostics":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: rrt-4161241190348351641-b-geu2-4210-928960-20)"}]}}}},"503":{"description":"Service unavailable. Response may be JSON as per example, or HTML message including the term \"503 Service Temporarily Unavailable\".","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"transient","details":{"text":"Code: 503, Display: Service Not Available"}}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Issue severity | Issue code | Description |\n| ----------- | -------------- | ------------- | --------------------------------------------- |\n| 400 | error | invalid | Bad request, error in business logic on the client's side |\n| 401 | error | forbidden | Unauthorized, access token missing, invalid or expired |\n| 403 | error | forbidden | There's no patient's consent to store SCR |\n| 420 | error | forbidden | Business condition related to access control which prevents the action being performed by PSIS |\n| 429 | error | - | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","details":{"text":"Code: 420, Display: Business condition related to access control which prevents the action being performed by PSIS;Code: 30418, Display: [PSIS-30418] - ACF does not permit access to resource"}}]}}}}}}},"/DocumentReference":{"get":{"summary":"Get patient's latest Summary Care Record identifier","operationId":"get-scr-id","description":"## Overview\nUse this endpoint to retrieve UUID of patient's latest record.\nThe UUID is required to retrieve the Summary Care Record details using GET /Bundle endpoint\nand to update the details of patient's Summary Care Record using POST /Bundle endpoint.\n\nThis endpoint also returns patient's consent status in the securityLabel attribute of a successful API response.\n\nTo get the information you must provide patient's NHS number.\nWhen no NHS Number is supplied in the patient query parameter, 400 HTTP status is returned.\n\n## Sandbox test scenarios\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ----------------------------------| --------------------------------- | ---------------------------------- |\n| Happy path | `nhs-number=9000000009` | HTTP Status 200 - Full Bundle |\n| Empty result | `nhs-number=9000000033` | HTTP Status 200 - Empty Bundle |\n| Invalid results | `nhs-number=INVALID NHS NUMBER` | HTTP Status 400 - Invalid Request |\n","parameters":[{"in":"header","name":"Authorization","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},{"in":"header","name":"X-Correlation-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.\n\nWhen contacting the helpdesk and asking them to trace logs in Splunk, please supply the X-Correlation-ID (GIUD) from the request you are attempting to debug.\n\nMirrored back in a response header.\n\nAvoid `.` characters.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\nIf you re-send a failed request, use the same value in this header.\nMirrored back in a response header.\n","schema":{"type":"string","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"}},{"in":"header","name":"NHSD-Session-URID","description":"\nThe user role ID (URID) for the current session. Also known as a user role profile ID (URPID).\n\nIn user-restricted access mode if you send this header it must be valid for the logged-in user. See [determine the user's role](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation#step-7-determine-the-user-s-role) for guidance.\n","required":false,"schema":{"type":"string","pattern":"^[0-9]+$","example":"555021935107"}},{"in":"query","name":"patient","description":"The patient's NHS number. Must be preceded with FHIR identifier (eg.\"patient=https://fhir.nhs.uk/Id/nhs-number|9000000009\")","required":true,"example":"https://fhir.nhs.uk/Id/nhs-number|9000000009","schema":{"type":"string"}},{"in":"query","name":"type","description":"General Practice Summary snomed code. Must be equal \"type=http://snomed.info/sct|196981000000101\"","required":false,"example":"http://snomed.info/sct|196981000000101","schema":{"type":"string"}},{"in":"query","name":"_sort","description":"Defines how Patient's SCR list should be sorted in order to retrieve the latest one. The only supported value is _sort=date. If a different value is provided 400 HTTP status will be returned.","required":false,"example":"date","schema":{"type":"string"}},{"in":"query","name":"_count","description":"Defines the number of latest patient SCR IDs that could be retrieved. Currently the only supported value is _count=1. If a different value is provided 400 HTTP status will be returned.","required":false,"example":1,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success response","content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","default":"Bundle"},"id":{"description":"UUID identifying the Bundle","type":"string","example":"92A00AC6-4C89-46A1-867D-2C448AC3809E"},"type":{"description":"Type of the bundle","type":"string","default":"searchset"},"total":{"description":"Number of results found","type":"integer","example":1},"entry":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"fullUrl":{"description":"Absolute resource URL address","type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/DocumentReference/D0AD7E01-5FAF-443C-B0D4-D4F6E37B65C3"},"resource":{"description":"A resource in the bundle. A reference to a document","type":"object","properties":{"resourceType":{"type":"string","default":"DocumentReference"},"id":{"type":"string","example":"D0AD7E01-5FAF-443C-B0D4-D4F6E37B65C3"},"masterIdentifier":{"description":"Master Version Specific Identifier","type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/Id/nhsSCRUUID"},"value":{"description":"Summary Care Record UUID","type":"string","example":"C058D90F-E526-4A27-A46E-E86229096AAC"}},"required":["system","value"]},"status":{"type":"string","default":"current"},"type":{"description":"Fixed value describing kind of document","type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","default":"196981000000101"},"display":{"type":"string","default":"General Practice Summary"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}}},"subject":{"description":"Subject of the document","type":"object","properties":{"reference":{"type":"string","example":"Patient/9b9a16ed-3cd0-45b2-ab1f-e625dd0251c1"}},"required":["reference"]},"securityLabel":{"description":"Information about patient's consent to View SCR","type":"array","items":{"type":"object","properties":{"coding":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/SCR-ACSPermission"},"code":{"description":"The following values are allowed: Yes, No, Ask. 'No' means the patient has an SCR opt-out. 'Ask' means permission to view is required. 'Yes' is a legacy functionality and not used, but if it is encountered it must be treated the same as 'Ask'.","type":"string","example":"Ask"}},"required":["system","code"]}}},"minItems":1,"maxItems":1},"content":{"description":"Document referenced","type":"array","items":{"type":"object","properties":{"attachment":{"type":"object","properties":{"url":{"type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Bundle?composition.identifier=C058D90F-E526-4A27-A46E-E86229096AAC&composition.subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009"}},"required":["url"]}},"required":["attachment"]},"minItems":1,"maxItems":1},"context":{"description":"Context of the document content","type":"object","properties":{"event":{"type":"array","items":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"http://snomed.info/sct"},"code":{"type":"string","default":"196981000000101"},"display":{"type":"string","default":"General Practice Summary"}},"required":["system","code","display"]},"minItems":1,"maxItems":1}}},"minItems":1,"maxItems":1}}}},"required":["resourceType","id","masterIdentifier","status","type","subject","securityLabel","content","context"]},"search":{"type":"object","properties":{"mode":{"type":"string","default":"match"}},"required":["mode"]}},"required":["fullUrl","resource","search"]},{"type":"object","properties":{"fullUrl":{"description":"UUID identifying resource within a bundle","type":"string","example":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/Patient/3346650E-BECA-4C00-BF07-18E27CE69114"},"resource":{"type":"object","properties":{"resourceType":{"type":"string","default":"Patient"},"id":{"type":"string","example":"3346650E-BECA-4C00-BF07-18E27CE69114"},"identifier":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/Id/nhs-number"},"value":{"description":"NHS number","type":"string","example":"9000000009"}},"required":["system","value"]},"minItems":1,"maxItems":1}},"required":["resourceType","identifier"]}}}]}}},"required":["resourceType","id","type","total"]},"examples":{"Example JSON SCR DocumentReference Bundle":{"summary":"Example SCR DocumentReference Bundle","value":{"resourceType":"Bundle","id":"55f8ba57-761a-406e-b61d-423027830fef","type":"searchset","total":1,"entry":[{"fullUrl":"https://api.service.nhs.uk/summary-care-record/FHIR/R4/DocumentReference/6d334ca8-a6e1-4bae-93b1-19a14a36ea7a","resource":{"resourceType":"DocumentReference","id":"6d334ca8-a6e1-4bae-93b1-19a14a36ea7a","masterIdentifier":{"system":"https://fhir.nhs.uk/Id/nhsSCRUUID","value":"FA60BE64-1F34-11EB-A2A8-000C29A364EB"},"status":"current","type":{"coding":[{"system":"http://snomed.info/sct","code":"196981000000101","display":"General Practice Summary"}]},"subject":{"reference":"Patient/9b9a16ed-3cd0-45b2-ab1f-e625dd0251c1"},"securityLabel":[{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/SCR-ACSPermission","code":"Ask"}]}],"content":[{"attachment":{"url":"https://api.service.nhs.uk/summary-care-record/Bundle?composition.identifier=FA60BE64-1F34-11EB-A2A8-000C29A364EB&composition.subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009"}}],"context":{"event":[{"coding":[{"system":"http://snomed.info/sct","code":"196981000000101","display":"General Practice Summary"}]}]}},"search":{"mode":"match"}},{"fullUrl":"9b9a16ed-3cd0-45b2-ab1f-e625dd0251c1","resource":{"resourceType":"Patient","id":"9b9a16ed-3cd0-45b2-ab1f-e625dd0251c1","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}]}}]}}}}}},"500":{"description":"Internal Server Error. A similar message could be triggered for 502 Bad Gateway or any other 5XX error. See the \"Errors\" section for more details.","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation error outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["error"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"unknown"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","default":"1"},"code":{"type":"string","example":"UNKNOWN_ERROR"},"display":{"type":"string","example":"Unknown Error"}}}}}},"diagnostics":{"type":"string","example":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})"}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"unknown","details":{"coding":{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":1,"code":"UNKNOWN_ERROR","display":"Unknown Error"}},"diagnostics":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: rrt-4161241190348351641-b-geu2-4210-928960-20)"}]}}}},"503":{"description":"Service unavailable. Response may be JSON as per example, or HTML message including the term \"503 Service Temporarily Unavailable\".","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"transient","details":{"text":"Code: 503, Display: Service Not Available"}}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Issue severity | Issue code | Description |\n| ----------- | -------------- | ------------- | --------------------------------------------- |\n| 400 | error | invalid | Bad request, error in business logic on the client's side |\n| 401 | error | forbidden | Unauthorized, access token missing, invalid or expired |\n| 403 | error | forbidden | There's no patient's consent to store SCR |\n| 429 | error | - | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","details":{"text":"Invalid access token"}}]}}}}}}},"/$setPermission":{"post":{"summary":"Update patient's consent to share SCR","operationId":"acs","description":"## Overview\nUse this endpoint to update the Permission to share the GP Summaries\n\n## Sandbox test scenarios\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| -------------------------------- | ---------------------------------------------------------------------------- | -------------------- |\n| Happy path | `NHSD-Session-URID`=`555254240100`; `nhsNumber`=`9000000009` | HTTP Status 201 |\n| Patient not found | `NHSD-Session-URID`=`555254240100`; `nhsNumber`=`9111231130` | HTTP Status 400 |\n","parameters":[{"in":"header","name":"Authorization","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},{"in":"header","name":"X-Correlation-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.\n\nWhen contacting the helpdesk and asking them to trace logs in Splunk, please supply the X-Correlation-ID (GIUD) from the request you are attempting to debug.\n\nMirrored back in a response header.\n\nAvoid `.` characters.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\nIf you re-send a failed request, use the same value in this header.\nMirrored back in a response header.\n","schema":{"type":"string","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"}},{"in":"header","name":"NHSD-Session-URID","description":"\nThe user role ID (URID) for the current session. Also known as a user role profile ID (URPID).\n\nIn user-restricted access mode if you send this header it must be valid for the logged-in user. See [determine the user's role](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation#step-7-determine-the-user-s-role) for guidance.\n","required":false,"schema":{"type":"string","pattern":"^[0-9]+$","example":"555021935107"}},{"in":"header","name":"Content-Type","description":"Used to indicate what type of data is actually sent\n","required":true,"schema":{"type":"string","example":"application/fhir+json"}}],"requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","default":"Parameters"},"parameter":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","default":"setPermissions"},"part":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","default":"nhsNumber"},"valueString":{"type":"string","example":9000000009}},"required":["name","valueString"]},{"type":"object","properties":{"name":{"type":"string","default":"permissionCode"},"valueCoding":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/SCR-ACSPermission"},"code":{"type":"string","description":"The following values are allowed: Yes, No, Ask. 'No' means the patient has an SCR opt-out. 'Ask' means permission to view is required. 'Yes' is a legacy functionality and not used, but if it is encountered it must be treated the same as 'Ask'."}},"required":["system","code"]}},"required":["name","valueCoding"]}]},"minItems":2,"maxItems":2}},"required":["name","part"]},"minItems":1,"maxItems":1}},"required":["resourceType","parameter"]},"examples":{"Example SetPermission Bundle":{"summary":"Example SetPermission Bundle","value":{"resourceType":"Parameters","parameter":[{"name":"setPermissions","part":[{"name":"nhsNumber","valueString":"9000000009"},{"name":"permissionCode","valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/SCR-ACSPermission","code":"Ask"}}]}]}}}}}},"responses":{"201":{"description":"Permission successfully updated"},"500":{"description":"Internal Server Error. A similar message could be triggered for 502 Bad Gateway or any other 5XX error. See the \"Errors\" section for more details.","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation error outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["error"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"unknown"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","default":"1"},"code":{"type":"string","example":"UNKNOWN_ERROR"},"display":{"type":"string","example":"Unknown Error"}}}}}},"diagnostics":{"type":"string","example":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})"}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"unknown","details":{"coding":{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":1,"code":"UNKNOWN_ERROR","display":"Unknown Server Side Error"}},"diagnostics":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: rrt-4161241190348351641-b-geu2-4210-928960-20)"}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Issue severity | Issue code | Description |\n| ----------- | -------------- | ------------- | --------------------------------------------- |\n| 400 | error | invalid | Bad request, error in business logic on the client's side |\n| 401 | error | forbidden | Unauthorized, access token missing, invalid or expired |\n| 413 | error | invalid | Content too large, request was larger than the server was able to handle. This is a host imposed limitation/error. |\n| 415 | error | not-supported | Unsupported Media Type, Content-Type header is invalid or missing. The following header should be sent with the request: `Content-Type: application/fhir+json` |\n| 429 | error | - | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"not-supported","details":{"text":"Content type 'text/plain' not supported"}}]}}}}}}},"/AuditEvent":{"post":{"summary":"Send a privacy alert message","operationId":"alert","description":"## Overview\nUse this endpoint to raise an Electronic Alert to an organisation's Privacy Officer(s) when a Care Professional in the same organisation creates a Self-Claim LR or accesses an SCR without the patient's permission.\n\nThe following combinations of type and subtype are possible. Note the non-permitted combinations in this list:\n| Requirement Identifier | Alert Type | Alert Type Display | Alert Sub-Type
(“Reason Code”) | Alert Sub-Type (“Reason Display”) | Business Scenario Notes |\n| ---------------------- | ---------- | ------------------------ | --------------------------------- | ---------------------------------- | ------------------------------------------ |\n| MSCA-SCR-103 | 1 | Create LR (Self Claimed) | 1 | Access made in the public interest | SCR accessed for legal reasons |\n| MSCA-SCR-103 | 1 | Create LR (Self Claimed) | 2 | Access required by statute | SCR accessed for legal reasons |\n| MSCA-SCR-103 | 1 | Create LR (Self Claimed) | 3 | Access required by Court Order | SCR accessed for legal reasons |\n| MSCA-SCR-103 | 1 | Create LR (Self Claimed) | 4 | Self-Claim Emergency Access | SCR accessed for emergency reasons |\n| n/a | 1 | n/a | 5 | n/a | Not a permitted combination |\n| MSCA-SCR-103 | 1 | Create LR (Self Claimed) | 6 | Other | SCR accessed with the patient's permission |\n| MSCA-SCR-105 | 2 | Access Alert | 1 | Access made in the public interest | SCR accessed for legal reasons |\n| MSCA-SCR-105 | 2 | Access Alert | 2 | Access required by statute | SCR accessed for legal reasons |\n| MSCA-SCR-105 | 2 | Access Alert | 3 | Access required by Court Order | SCR accessed for legal reasons |\n| n/a | 2 | n/a | 4 | n/a | Not a permitted combination |\n| MSCA-SCR-104 | 2 | Access Alert | 5 | Access made in an emergency | SCR accessed for emergency reasons. |\n| n/a | 2 | n/a | 6 | n/a | Not a permitted combination |\n\n## Sandbox test scenarios\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| -------------------------------- | ---------------------------------------- | -------------------- |\n| Happy path | `nhsNumber`=`9000000009` | HTTP Status 201 |\n","parameters":[{"in":"header","name":"Authorization","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},{"in":"header","name":"X-Correlation-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.\n\nWhen contacting the helpdesk and asking them to trace logs in Splunk, please supply the X-Correlation-ID (GIUD) from the request you are attempting to debug.\n\nMirrored back in a response header.\n\nAvoid `.` characters.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\nIf you re-send a failed request, use the same value in this header.\nMirrored back in a response header.\n","schema":{"type":"string","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"}},{"in":"header","name":"NHSD-Session-URID","description":"\nThe user role ID (URID) for the current session. Also known as a user role profile ID (URPID).\n\nIn user-restricted access mode if you send this header it must be valid for the logged-in user. See [determine the user's role](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation#step-7-determine-the-user-s-role) for guidance.\n","required":false,"schema":{"type":"string","pattern":"^[0-9]+$","example":"555021935107"}},{"in":"header","name":"Content-Type","description":"Used to indicate what type of data is actually sent\n","required":true,"schema":{"type":"string","example":"application/fhir+json"}}],"requestBody":{"required":true,"content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"type":"string","default":"AuditEvent"},"id":{"type":"string","example":"1C03CF4F-D404-4D76-B192-4F81727059F6"},"extension":{"description":"Notification message to be displayed on forwarding the Alert","type":"array","items":{"type":"object","properties":{"url":{"type":"string","default":"https://fhir.nhs.uk/StructureDefinition/Extension-SCR-NotificationMessage"},"valueString":{"type":"string","example":"Alert: Permission to view override 1C03CF4F-D404-4D76-B192-4F81727059F6"}},"required":["url","valueString"]}},"type":{"description":"A parent valueset to subtype to identify the reason a viewing alert has been triggered while viewing a Summary Care Record","type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/SCR-AlertType"},"code":{"type":"string","enum":[1,2],"example":1},"display":{"type":"string","default":"Create LR (Self Claimed)"}},"required":["system","code","display"]},"subtype":{"description":"A valueset to identify the reason a viewing alert has been triggered while viewing a Summary Care Record","type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/SCR-AlertReason"},"code":{"type":"string","enum":[1,2,3,4,5,6],"example":1},"display":{"type":"string","example":"Access made in the public interest"}},"required":["system","code","display"]},"minItems":1,"maxItems":1},"recorded":{"description":"The time when the event was recorded","type":"string","example":"2020-11-13T00:00:00+00:00"},"outcomeDesc":{"description":"Free text field. Used to explain the nature of the access. Always optional.","type":"string","example":"Patient collapsed - needed to check current medication."},"agent":{"type":"array","items":{"type":"object","description":"An actor taking an active role in the event or activity that is logged.","properties":{"who":{"type":"object","properties":{"identifier":{"type":"object","properties":{"system":{"type":"string","example":"https://fhir.nhs.uk/Id/sds-user-id"},"value":{"type":"string","example":"T10101"}},"required":["system","value"]}},"required":["identifier"]},"role":{"description":"Agent role in the event","type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"General Practitioner"}},"required":["text"]}},"requestor":{"description":"Whether user is initiator","type":"boolean","default":false}},"required":["who","requestor"]},"minItems":3,"maxItems":3},"source":{"description":"The system that is reporting the event.","type":"object","properties":{"observer":{"description":"The identity of source detecting the event","type":"object","properties":{"identifier":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/Id/nhsSpineASID"},"value":{"type":"string","example":227319907548}},"required":["system","value"]}},"required":["identifier"]}},"required":["observer"]},"entity":{"description":"Specific instances of data or objects that have been accessed","type":"array","items":{"type":"object","properties":{"what":{"description":"Identifies a specific instance of the entity","type":"object","properties":{"identifier":{"type":"object","properties":{"value":{"type":"string","example":"1C03CF4F-D404-4D76-B192-4F81727059F6"}},"required":["value"]}},"required":["identifier"]}},"required":["what"]}}},"required":["resourceType","id","extension","type","subtype","recorded","agent","source","entity"]},"examples":{"Example JSON of AuditEvent":{"summary":"Example JSON of AuditEvent","value":{"resourceType":"AuditEvent","id":"example","extension":[{"url":"https://fhir.nhs.uk/StructureDefinition/Extension-SCR-NotificationMessage","valueString":"Alert: Permission to view override 1C03CF4F-D404-4D76-B192-4F81727059F6"}],"type":{"system":"https://fhir.nhs.uk/CodeSystem/SCR-AlertType","code":"1","display":"Create LR (Self Claimed)"},"subtype":[{"system":"https://fhir.nhs.uk/CodeSystem/SCR-AlertReason","code":"1","display":"Access made in the public interest"}],"outcomeDesc":"a test alert","recorded":"2020-11-13T00:00:00+00:00","agent":[{"who":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"requestor":false},{"who":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"T10101"}},"requestor":false},{"who":{"identifier":{"system":"https://fhir.nhs.uk/Id/sds-user-id","value":"T10101"}},"role":[{"text":"General Practitioner"}],"requestor":false}],"source":{"observer":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"227319907548"}}},"entity":[{"what":{"identifier":{"value":"1C03CF4F-D404-4D76-B192-4F81727059F6"}}}]}}}}}},"responses":{"201":{"description":"Success response"},"500":{"description":"Internal Server Error. A similar message could be triggered for 502 Bad Gateway or any other 5XX error. See the \"Errors\" section for more details.","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation error outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["error"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"unknown"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"type":"object","properties":{"system":{"type":"string","default":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode"},"version":{"type":"string","default":"1"},"code":{"type":"string","example":"UNKNOWN_ERROR"},"display":{"type":"string","example":"Unknown Error"}}}}}},"diagnostics":{"type":"string","example":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: {messageid})"}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"unknown","details":{"coding":{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":1,"code":"UNKNOWN_ERROR","display":"Unknown Error"}},"diagnostics":"An unknown server-side error occurred processing this request. Contact us for assistance diagnosing this issue: https://digital.nhs.uk/developer/help-and-support. (Message ID: rrt-4161241190348351641-b-geu2-4210-928960-20)"}]}}}},"4XX":{"description":"An error occurred as follows:\n\n| HTTP status | Issue severity | Issue code | Description |\n| ----------- | -------------- | ------------- | --------------------------------------------- |\n| 400 | error | invalid | Bad request, error in business logic on the client's side |\n| 401 | error | forbidden | Unauthorized, access token missing, invalid or expired |\n| 413 | error | invalid | Content too large, request was larger than the server was able to handle. This is a host imposed limitation/error. |\n| 415 | error | not-supported | Unsupported Media Type, Content-Type header is invalid or missing. The following header should be sent with the request: `Content-Type: application/fhir+json` |\n| 429 | error | - | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n","content":{"application/fhir+json":{"schema":{"type":"object","description":"Operation outcome","properties":{"resourceType":{"type":"string","description":"FHIR Resource Type.","default":"OperationOutcome"},"issue":{"type":"array","description":"List of issues that have occurred.","minItems":1,"items":{"type":"object","required":["severity","code"],"properties":{"severity":{"type":"string","enum":["fatal","error","warning","information"],"description":"Severity of the error.","example":"error"},"code":{"type":"string","description":"error code.","example":"invalid"},"details":{"type":"object","properties":{"text":{"type":"string","description":"detailed information"}}}}}}}},"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"text":"NHS number missing"}}]}}}}}}}},"components":{"parameters":{"BearerAuthorization":{"in":"header","name":"Authorization","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\nRequired in all environments except sandbox.\n","required":true,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},"CorrelationID":{"in":"header","name":"X-Correlation-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk.\n\nWhen contacting the helpdesk and asking them to trace logs in Splunk, please supply the X-Correlation-ID (GIUD) from the request you are attempting to debug.\n\nMirrored back in a response header.\n\nAvoid `.` characters.\n","schema":{"type":"string","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"}},"RequestID":{"in":"header","name":"X-Request-ID","required":false,"description":"A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\nIf you re-send a failed request, use the same value in this header.\nMirrored back in a response header.\n","schema":{"type":"string","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"}},"RoleID":{"in":"header","name":"NHSD-Session-URID","description":"\nThe user role ID (URID) for the current session. Also known as a user role profile ID (URPID).\n\nIn user-restricted access mode if you send this header it must be valid for the logged-in user. See [determine the user's role](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-combined-authentication-and-authorisation#step-7-determine-the-user-s-role) for guidance.\n","required":false,"schema":{"type":"string","pattern":"^[0-9]+$","example":"555021935107"}},"ContentType":{"in":"header","name":"Content-Type","description":"Used to indicate what type of data is actually sent\n","required":true,"schema":{"type":"string","example":"application/fhir+json"}}}}}