{"openapi":"3.0.3","info":{"title":"Digital Genomics Test Service (FHIR) API","description":"\n## Overview\nThe [NHS Genomic Medicine Service](https://www.england.nhs.uk/genomics/) enables the NHS to harness the power of genomic technology and science to improve the health of our population and deliver on the commitments in the [NHS Long Term Plan](https://www.longtermplan.nhs.uk/) including:\n* to be the first national health care system to offer whole genome sequencing as part of routine care, including for all children with cancer or children who are seriously ill with a likely genetic disorder\n* increased access to molecular diagnostics and offer genomic testing routinely to all people with cancer\n \n* improve early detection and treatment of high-risk conditions including expanding genomic testing for familial hypocholesterolaemia\n* linking and correlating genomic data to help provide new treatments, diagnostic approaches and help patients make informed decisions about their care\n\nA [strategy](https://www.england.nhs.uk/long-read/accelerating-genomic-medicine-in-the-nhs/) for embedding genomics in the NHS over the next 5 years was published in October 2022 outlined four priority areas:\n1. embedding genomics across the NHS, through a world leading innovative service model from primary and community care through to specialist and tertiary care\n\n2. delivering equitable genomic testing for improved outcomes in cancer, rare, inherited and common diseases and in enabling precision medicine and reducing adverse drug reactions\n\n3. enabling genomics to be at the forefront of the data and digital revolution, ensuring genomic data can be interpreted and informed by other diagnostic and clinical data\n\n4. evolving the service through cutting-edge science, research and innovation to ensure that patients can benefit from rapid implementation of advances\n\n\nThe **[Digital Genomics Test Service](https://ngtd.england.federateddataplatform.nhs.uk/)** forms part of the core digital service in enabling to accelerate services into clinical,research,population health & management insight settings. The scope of this service is the digitisation of **[National Genomic Test Directory](https://www.england.nhs.uk/publication/national-genomic-test-directories/)** within the whole of NHSE. Key points in scope:\n* it is a central national reference data standard within aim to provide consistent information around genomic test packages and tests\n* it is focusing on the standardising the relevant tests and its meta data.\n\nClinical users in NHS will be able to:\n* access list of genomic test packages for their speciality\n\n* retrieve detailed information around the test packages including version and status\n\n* identify genomic tests within genomic test packages\n\n* retrieve detailed information around the genomic tests including versions\n\n## Who can use this API\n  This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.\n\n## Related APIs\n   \n### Services\nThese services must be used alongside genomic order management service to create a genetic test request, status tracking, updates and report access:\n* [Genomic Order Management Service API](https://digital.nhs.uk/developer/api-catalogue/genomic-order-management-service-fhir) - Genomic Orders Management Service capability in digitising non-WGS and WGS pathways.\n### Documentation\nThis documentation provides important context:\n* [Genomic Test Directory](https://www.england.nhs.uk/publication/national-genomic-test-directories/) - The national genomic test directory specifies which genomic tests are commissioned by the NHS in England, the technology by which they are available, and the patients who will be eligible to access to a test.\n* [Genomic Laboratory Hubs](https://www.england.nhs.uk/genomics/genomic-laboratory-hubs/) - Genomic testing in the NHS is being provided through a national testing network, consolidating and enhancing the existing laboratory provision.\n\n### Guidance for developers and product owners\nDocumentation and guidance for technical audiences:\n* [Implementation guide for Genomics FHIR standard](https://simplifier.net/guide/fhir-genomics-implementation-guide/Home/Design/Interactions) - the implementation guide contains detailed information, example, error codes and processes. This is for technical audiences like developers.\n\n* [FHIR UK Core R4](https://simplifier.net/hl7fhirukcorer4) - Core FHIR standard mandated for adoption and implementation in UK and our [Genomics IG]((https://simplifier.net/guide/fhir-genomics-implementation-guide/Home/Design/Interactions) is based on this standard.\n\n## API status and roadmap\nThe data and digital framework established as part of the [genomics strategy](https://www.england.nhs.uk/long-read/accelerating-genomic-medicine-in-the-nhs/) outlined 3 major deliverables to accelerate the digital adoption and improve services.\n* digital genomics test service\n\n* genomic order management service\n\n* unified genomic record\n\nThe immediate priority of Genomics Test Directory Services development is to support the rollout of the improved test directory for primary care and secondary care settings for genetics ordering and GLH's in provding the  testing services.\n\nThis API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses), meaning:\n* it is available for testing in the integration environment\n\n* we expect to make breaking changes based on developer feedback\n\n## Service level\nThis API is a platinum service, meaning it is operational and supported 24 hours a day, 365 days a year.\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\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](http://hl7.org/fhir/R4/http.html#capabilities) interaction. \nRefer to [Genomics FHIR IG](https://simplifier.net/guide/fhir-genomics-implementation-guide/Home) for more details to the implementation requirements for [DGTS](https://simplifier.net/guide/FHIR-Genomics-Implementation-Guide/Home/Design/DGTS-Integration.page.md?version=current). This specification is based on UK Core Ballot2 and conforms to the same.\n\nYou do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules. In particular:\n* resource names are capitalised and singular, for example `/Patient` not `/patients`\n* array names are singular, for example `line` not `lines` for address lines\n* data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an `extension` object\n\nThere are [libraries and software development kits available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.\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\n* application-restricted access (**ALPHA/BETA/LIVE**) [Application-restricted RESTful API - signed JWT  authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\n**FOR ALPHA** phase the API could also be integrated using application-restricted access using [API key  authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-api-key-authentication)\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\n* 400 to 499 if it failed because of a client error by your application\n\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## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful.\n## Environment and testing\n| Environment      | Base URL                                                            |\n|------------------|---------------------------------------------------------------------|\n| Integration          |`https://int.api.service.nhs.uk/digital-genomics-test-directory-service`|\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\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## 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 is worth planning well ahead.\n\nWhilst this API is in Alpha it is not possible to onboard to this API. As 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. Information on this page might impact the design of your software.\n\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding#using-the-digital-onboarding-portal).\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","version":"v0.0.3Alpha"},"servers":[{"url":"https://sandbox.api.service.nhs.uk/digital-genomics-test-service","description":"Sandbox"},{"url":"https://int.api.service.nhs.uk/digital-genomics-test-service","description":"Integration"}],"paths":{"/FHIR/R4/PlanDefinition":{"get":{"tags":["genomictestpackages"],"summary":"Search for Test Package resources","description":"This endpoint allows you to retrieve the records of [Test Package](https://simplifier.net/guide/FHIR-Genomics-Implementation-Guide/Home/FHIRAssets/Profiles/All-Profiles/PlanDefinition.page.md?version=current) using various query parameter.","operationId":"searchTestPackage","parameters":[{"$ref":"#/components/parameters/apikey"},{"$ref":"#/components/parameters/NHSDSessionURID"},{"$ref":"#/components/parameters/RequestID"},{"$ref":"#/components/parameters/CorrelationID"},{"$ref":"#/components/parameters/LogicalIdentifier"},{"$ref":"#/components/parameters/Identifier"},{"$ref":"#/components/parameters/Title"},{"$ref":"#/components/parameters/Status"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/Context"}],"responses":{"200":{"description":"Successful search","content":{"application/fhir+json":{"schema":{"$ref":"http://hl7.org/fhir/StructureDefinition/PlanDefinition"}}}},"4XX":{"$ref":"#/components/responses/4XX-dgts-error"}},"deprecated":false}},"/FHIR/R4/ActivityDefinition":{"get":{"tags":["genomictests"],"summary":"Search for Genomic Test resources","description":"This endpoint allows you to retrieve the records of [Genomic Test](https://simplifier.net/guide/FHIR-Genomics-Implementation-Guide/Home/FHIRAssets/Profiles/All-Profiles/ActivityDefinition.page.md?version=current) using various query parameter.","operationId":"searchTest","parameters":[{"$ref":"#/components/parameters/apikey"},{"$ref":"#/components/parameters/NHSDSessionURID"},{"$ref":"#/components/parameters/RequestID"},{"$ref":"#/components/parameters/CorrelationID"},{"$ref":"#/components/parameters/LogicalIdentifier"},{"$ref":"#/components/parameters/Identifier"},{"$ref":"#/components/parameters/Title"},{"$ref":"#/components/parameters/Status"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/Context"}],"responses":{"200":{"description":"Successful search","content":{"application/fhir+json":{"schema":{"$ref":"http://hl7.org/fhir/StructureDefinition/ActivityDefinition"}}}},"4XX":{"$ref":"#/components/responses/4XX-dgts-error"}},"deprecated":false}},"/FHIR/R4/Library":{"get":{"tags":["genomiclibrary"],"summary":"Search for Library resources","description":"This endpoint allows you to retrieve the records of [Library](https://simplifier.net/guide/FHIR-Genomics-Implementation-Guide/Home/FHIRAssets/Profiles/All-Profiles/Library.page.md?version=current) using various query parameter.","operationId":"searchLibrary","parameters":[{"$ref":"#/components/parameters/apikey"},{"$ref":"#/components/parameters/NHSDSessionURID"},{"$ref":"#/components/parameters/RequestID"},{"$ref":"#/components/parameters/CorrelationID"},{"$ref":"#/components/parameters/LogicalIdentifier"},{"$ref":"#/components/parameters/Identifier"},{"$ref":"#/components/parameters/Url"}],"responses":{"200":{"description":"Successful search","content":{"application/fhir+json":{"schema":{"$ref":"http://hl7.org/fhir/StructureDefinition/Library"}}}},"4XX":{"$ref":"#/components/responses/4XX-dgts-error"}},"deprecated":false}},"/FHIR/R4/{resourceName}/{id}":{"get":{"tags":["genomictestresource"],"summary":"Search for resource by its logical id","description":"## Overview\nThis endpoint allows you to retrieve the record of a single FHIR resource latest version by its logical id.\n","operationId":"readResource","parameters":[{"$ref":"#/components/parameters/apikey"},{"$ref":"#/components/parameters/NHSDSessionURID"},{"$ref":"#/components/parameters/RequestID"},{"$ref":"#/components/parameters/CorrelationID"},{"$ref":"#/components/parameters/ResourceName"},{"$ref":"#/components/parameters/Id"}],"responses":{"200":{"description":"Successful get by logical Id","content":{"application/fhir+json":{"schema":{"$ref":"http://hl7.org/fhir/StructureDefinition/ActivityDefinition"}}}},"4XX":{"$ref":"#/components/responses/4XX-dgts-error"}},"deprecated":false}},"/FHIR/R4/metadata":{"get":{"tags":["meta"],"summary":"Get the capability statement from the FHIR server","description":"## Overview\nThis endpoint allows to retrieve the [DGTS capability statement](https://simplifier.net/guide/FHIR-Genomics-Implementation-Guide/Home/FHIRAssets/CapabilityStatements/DGTS.page.md?version=current) from server\n","operationId":"readMetadata","parameters":[{"$ref":"#/components/parameters/apikey"}],"responses":{"200":{"description":"Successful retrieval of metadata."}},"deprecated":false}}},"components":{"schemas":{},"responses":{"4XX-dgts-error":{"description":"Below are examples of potential HTTP status codes and their associated error codes, which could be returned in the event of a fault.\n\n| HTTP status | Error code                 | Description |\n| ----------- | -------------------------- | --------------------------------------------- |\n| 400         | INVALID                    | The provided event ID is either missing or not in the expected format. |\n| 400         | BAD_REQUEST                | Search could not be processed or failed basic FHIR validation rules  |\n| 401         | UNAUTHORISED               | Authorization is required for the interaction that was attempted  |\n| 400         | BAD_REQUEST                | The resource could not be parsed or failed basic FHIR validation rules  |\n| 404         | NOT_FOUND                  | The requested resource was not found. |\n| 405         | NOT_ALLOWED                | The requested method is not allowed  |\n| 422         | UNPROCESSABLE_ENTITY       | The proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail  |\n","content":{"application/fhir+json":{"schema":{"type":"object","properties":{"resourceType":{"enum":["OperationOutcome"],"type":"string","description":"FHIR Resource Type.","example":"OperationOutcome"},"issue":{"minItems":1,"type":"array","items":{"required":["severity","code"],"type":"object","properties":{"severity":{"enum":["fatal","error","warning","information"],"type":"string","description":"Severity of the error.","example":"error"},"code":{"enum":["invalid","structure","required","value","invariant","security","login","unknown","expired","forbidden","suppressed","processing","not-supported","duplicate","multiple-matches","not-found","deleted","too-long","code-invalid","extension","too-costly","business-rule","conflict","transient","lock-error","no-store","exception","timeout","incomplete","throttled","informational"],"type":"string","description":"FHIR error code.","example":"invalid"},"details":{"type":"object","properties":{"coding":{"type":"array","items":{"required":["system","code"],"type":"object","properties":{"system":{"enum":["https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode"],"type":"string","description":"URI of the coding system specification."},"code":{"type":"string","description":"Symbol in syntax defined by the system.","example":"INVALID_VALUE"},"display":{"type":"string","description":"Representation defined by the system.","example":"Provided value is invalid"}}}}},"description":"Internal error code."},"diagnostics":{"pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"Additional diagnostic information about the issue."},"location":{"type":"array","items":{"pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.  For HTTP errors, will be \"http.\" + the parameter name."}},"expression":{"type":"array","items":{"pattern":"[ \\r\\n\\t\\S]+","type":"string","description":"A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised."}}}},"description":"List of issues that have occurred."}},"description":"Outcome of an operation that does not result in a resource or bundle being returned (for example, error, async/batch submission).\n"},"examples":{"single_item":{"description":"An error response to a request.\n","value":{"resourceType":"OperationOutcome","meta":{"lastUpdated":"2022-10-21T13:47:00+00:00"},"issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/Spine-ErrorOrWarningCode","code":"MISSING_FIELD","display":"ResourceType Bundle must contain 'entry' field"}]}}]}}}}}}},"parameters":{"CorrelationID":{"name":"X-Correlation-ID","in":"header","description":"An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. Mirrored back in a response header.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"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}$","type":"string","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},"If-Match":{"name":"If-Match","in":"header","description":"The version id for the resource updated\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":1}},"GetPages":{"name":"_getpages","in":"query","description":"Pages identifier\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"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}$","type":"string","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},"GetPageOffset":{"name":"_getpagesoffset","in":"query","description":"Page Offset\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":20}},"Count":{"name":"_count","in":"query","description":"Page Offset\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":20}},"RequestID":{"name":"X-Request-ID","in":"header","description":"A optional globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\nIf you re-send a failed request, use the same value in this header.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"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}$","type":"string","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068"}},"PatientIdentifier":{"name":"patient:identifier","in":"query","description":"The patient's NHS number.\nExpressed as `<type>|<value>` where `<type>` must be `https://fhir.nhs.uk/Id/nhs-number` and `<value>` must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"https://fhir.nhs.uk/Id/nhs-number|9000000009"}},"Identifier":{"name":"identifier","in":"query","description":"The resource identifier.\nExpressed as `<system>|<value>`\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"https://example.org.system|ABCD1234"}},"PractitionerIdentifier":{"name":"practitioner:identifier","in":"query","description":"The practitioner identifier within PractitionerRole.practitioner reference object.\nExpressed as `<system>|<value>`\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"https://example.org.system|ABCD1234"}},"DateFrom":{"name":"-date.from","in":"query","description":"The earliest date to be included (e.g. 2020-01-01)","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"1900-01-01"}},"DateTo":{"name":"-date.to","in":"query","description":"The latest date to be included (e.g. 2020-12-31)","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"9999-12-31"}},"Authored":{"name":"authored","in":"query","description":"Search by date request signed - ServiceRequest.authoredOn","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"1900-01-01"}},"Name":{"name":"name","in":"query","description":"Name of the Test","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Title":{"name":"title","in":"query","description":"Title of the Test","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Url":{"name":"url","in":"query","description":"Canonical URL of the resource","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Version":{"name":"version","in":"query","description":"Version of the Test","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Context":{"name":"context","in":"query","description":"Context of the Test","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"TaskAuthored":{"name":"authored-on","in":"query","description":"Search by creation date - Task.authoredOn","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"1900-01-01"}},"ReportIssued":{"name":"issued","in":"query","description":"When the report was issued - DiagnosticReport.issued","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"1900-01-01"}},"BasedOn":{"name":"based-on","in":"query","description":"The service request reference the report related to","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"b4dccd9f-1f49-45aa-8566-3a517fc98d3d"}},"SpecimenCollected":{"name":"collected","in":"query","description":"The date the specimen was collected  Specimen.collection.collected","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"1900-01-01"}},"ContainerIdentifier":{"name":"container-id","in":"query","description":"Search based on the unique identifier associated with the specimen container - Specimen.container.identifier","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"b4dccd9f-1f49-45aa-8566-3a517fc98d3d"}},"LogicalIdentifier":{"name":"_id","in":"query","description":"The logical identifier of the resource","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"b4dccd9f-1f49-45aa-8566-3a517fc98d3d"}},"Include":{"name":"_include","in":"query","description":"The parameter _include is used to follow links 'forward'. For example, `ServiceRequest:patient`, will include patient demographic details referenced within the ServiceRequest.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Graph":{"name":"graph","in":"query","description":"The parameter to get all information related to a service request based on  it logical identifier and associated [graph definition](https://simplifier.net/guide/FHIR-Genomics-Implementation-Guide/Home/FHIRAssets/GraphDefinitions) on server.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","default":"genomics-test-order"}},"TaskInclude":{"name":"_include","in":"query","description":"The parameter _include is used to follow links 'forward'. For example, `Task:owner`, will include Organisation details of the owning the task.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"SpecimenInclude":{"name":"_include","in":"query","description":"The parameter _include is used to follow links 'forward'. For example, `Specimen:request`, will include ServiceRequest details managing the Specimen.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"SpecimenRevInclude":{"name":"_revinclude","in":"query","description":"The parameter _revinclude is used to follow reverse links. For example. 'Task:input' will include all tasks managing the specimen workflows.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"SpecimenRequest":{"name":"request","in":"query","description":"The parameter search specimen based on service request logical id.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"DiagnosticReportInclude":{"name":"_include","in":"query","description":"The parameter _include is used to follow links 'forward'. `DiagnosticReport:patient`, will include patient demographic details referenced within the DiagnosticReport.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"RevInclude":{"name":"_revinclude","in":"query","description":"The parameter _revinclude is used to follow reverse links. For example `Task:focus`, will include Tasks that references the ServiceRequest through focus attributes.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"TaskRevInclude":{"name":"_revinclude","in":"query","description":"The parameter _revinclude is used to follow reverse links. For example `Task:focus`, will include Tasks that references the ServiceRequest through focus attributes.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Requestor":{"name":"requester","in":"query","description":"Parameter to search based on requesting Organisation","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Performer":{"name":"performer","in":"query","description":"Parameter to search based on performing Organisation","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"ResultsInterpreter":{"name":"results-interpreter","in":"query","description":"Parameter to search based on ResultsInterpreter Organisation","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Owner":{"name":"owner","in":"query","description":"Parameter to search based on owning Organisation","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Status":{"name":"status","in":"query","description":"Parameter to search based on Status of a Resource","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Organisation":{"name":"organization:identifier","in":"query","description":"Parameter to search based on organisation code","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"GivenName":{"name":"given","in":"query","description":"Parameter to search based on GivenName of a Patient","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"FamilyName":{"name":"family","in":"query","description":"Parameter to search based on FamilyName of a Patient","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"DateOfBirth":{"name":"birthdate","in":"query","description":"Parameter to search based on DateOfBirth of a Patient","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"date","default":"9999-12-31"}},"Gender":{"name":"gender","in":"query","description":"Parameter to search based on Gender of a Patient","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"TestID":{"name":"code","in":"query","description":"Parameter to search Service Request based on [test directory code](https://www.england.nhs.uk/publication/national-genomic-test-directories/)","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"Category":{"name":"category","in":"query","description":"Parameter to search Service Request based on [category](https://simplifier.net/guide/fhir-genomics-implementation-guide/Home/FHIRAssets/ValueSets#Genomic-Test-Types)","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"SupportingInfo":{"name":"supporting-info","in":"query","description":"Parameter to search Service Request based on supporting info in the test","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"BusinessStatus":{"name":"business-status","in":"query","description":"Parameter to search based on [BusinessStatus](https://simplifier.net/guide/fhir-genomics-implementation-guide/Home/FHIRAssets/ValueSets#Genomic-Business-Status) of a Task Resource","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"TaskCode":{"name":"code","in":"query","description":"Parameter to search based on [TaskCode](https://simplifier.net/guide/fhir-genomics-implementation-guide/Home/FHIRAssets/CodeSystems#Genomic-Task-Code) of a Task Resource","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string"}},"NHSDSessionURID":{"name":"NHSD-Session-URID","in":"header","description":"The user role ID (URID) for the current session. Also known as a user role profile ID (URPID).\nIf you are using User-restricted RESTful APIs - NHS login separate authentication and authorisation, see [determine the user's role](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-cis2-separate-authentication-and-authorisation#step-9-determine-the-user-s-role) for guidance. This field is optional.\n","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"pattern":"^[0-9]+$","type":"string","example":"555254240100"}},"apikey":{"name":"apikey","in":"header","description":"An [apikey based on ](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-api-key-authentication) application restricted restful apis.\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"^apikey\\ [[:ascii:]]+$","example":"58d6862a-61aa-4bdb-9361-392fe4a00dd4"}},"Authorization":{"name":"Authorization","in":"header","description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis). Required in all environments except sandbox.\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","format":"^Bearer\\ [[:ascii:]]+$","example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM"}},"Id":{"name":"id","in":"path","description":"A required ID which you can use to identify an unique resource object.\nMirrored back in a response header.\n","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"29dc4e84-7e72-11ee-b962-0242ac120002"}},"VersionId":{"name":"versionId","in":"path","description":"The specific version Id which you can use to identify an unique resource object with its logical Id.","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"1"}},"ResourceName":{"name":"resourceName","in":"path","description":"The specific resource type","required":true,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"enum":["PlanDefinition","ActivityDefinition","Library","SpecimenDefinition"],"type":"string","example":"PlanDefinition"}}},"requestBodies":{},"headers":{"Location":{"name":"","in":"header","description":"The location of the resource.","required":false,"deprecated":false,"allowEmptyValue":false,"explode":false,"allowReserved":false,"schema":{"type":"string","example":"29dc4e84-7e72-11ee-b962-0242ac120002"}}}},"tags":[{"name":"genomictestpackages"},{"name":"genomictests"},{"name":"genomictestresource"},{"name":"genomiclibrary"}],"x-spec-publication":{"operation-order":[{"operations":[{"method":"GET","path":"/FHIR/R4/PlanDefinition"}]},{"operations":[{"method":"GET","path":"/FHIR/R4/ActivityDefinition"}]}]}}