{"openapi":"3.0.3","info":{"title":"Pathology and Laboratory Medicine Reporting - FHIR API","description":"## Overview\nUse this API to send structured pathology test reports from a laboratory middleware system to the organisation that requested the test in general practice, and to retrieve acknowledgements provided by the general practice organisation.\n\n![Pathology API High-level Diagram](https://digital.nhs.uk/binaries/content/gallery/website/developer/api-catalogue/pathology-laboratory-reporting/pathology-and-laboratory-medicine-reporting-fhir-api-new.png)\n\n
\n
\n \n
\n \n \n \n \n \n \n \n

How it works

\n
\n \n
\n

Laboratory middleware systems receive and process batches of test reports from Laboratory Information Management Systems (LIMS), following which:

\n
    \n
  1. Laboratory middleware systems send individual test reports to the Pathology API. Each test report relates to a single Patient, but may contain multiple observations.
    2. \n
  2. The Pathology API validates the request and stores the test report in Patient Data Manager (PDM).
    3. \n
  3. Once stored, the Pathology API publishes an event to the Multicast Notification Service (MNS), containing details of the organisation that requested the test and a pointer to where the test report is stored in PDM.
    4. \n
  4. General Practice Information Management (GPIT) systems subscribe to Pathology and Laboratory Medicine Reporting test report stored events, with relevant events delivered to them.
    5. \n
  5. GPIT systems use the information specified on MNS events to retrieve test reports from Patient Data Manager.
    6. \n
\n

Once GPIT systems have retrieved and processed a test report:

\n
    \n
  1. GPIT systems store a Pathology and Laboratory Medicine Reporting acknowledgement in Patient Data Manager, confirming whether they were able to successfully process the test report.
    2. \n
  2. Once stored, PDM publishes an event to MNS, containing a pointer to where the acknowledgement is stored.
    3. \n
  3. Laboratory middleware systems subscribe to Pathology and Laboratory Medicine Reporting acknowledgement events, with relevant events delivered to them.
    4. \n
  4. Laboratory middleware systems use the information specified on MNS events to retrieve acknowledgements from the Pathology API.
    5. \n
  5. The Pathology API retrieves acknowledgements from PDM and returns them to a laboratory middleware system.
    6. \n
\n
\n
\n
\n
\n\nUsing this API you can:\n- Send a laboratory test report\n- Retrieve a test report acknowledgement\n\nThis API replaces the current [Pathology Messaging - EDIFACT API](https://digital.nhs.uk/developer/api-catalogue/pathology-messaging-edifact) and provides support for the following pathology specialisms, with further specialism coverage under review:\n- clinical biochemistry (also known as chemical pathology), haematology, immunology, and transfusion medicine\n- microbiology - this includes bacteriology, virology, and serology\n\n## Who can use this API\nYou can use this API if you are a software developer for a middleware application, supporting the aggregation and dissemination of pathology test reports from Laboratory Information Management Systems (LIMS).\n\nYou must register with us prior to using the API, with onboarding currently restricted to invited applications only.\n\n## Related APIs\nThe following APIs are used by the Pathology and Laboratory Medicine Reporting API to facilitate the storage and retrieval of pathology test report and acknowledgement bundles, and the publication of events to GP systems:\n\n- [Patient Data Manager FHIR API](https://digital.nhs.uk/developer/api-catalogue/patient-data-manager) - used to store, retrieve, and manage patient healthcare data in a standardised, interoperable format.\n- [Multicast Notification Service API](https://digital.nhs.uk/developer/api-catalogue/multicast-notification-service) - used to publish and receive patient-related healthcare events.\n\n## API status and roadmap\nThis API is currently [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\n\n## Service level\nTo be confirmed.\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#basic-rest) and conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir) global standards for health care data exchange, specifically to [FHIR Release 4](https://www.hl7.org/fhir/R4/).\n\nThe FHIR R4 API is built alongside the [NHS England Pathology FHIR Implementation Guide](https://simplifier.net/guide/pathology-fhir-implementation-guide), which is built on top of [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core).\n\n## Network access\nThis API is available on the internet.\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 one access mode:\n- [application-restricted access](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis)\n\n### Application-restricted access\nWith application-restricted access, we authenticate the calling application but not the end user. This access mode can be used when an end user is not present, for example as part of an automated process.\n\nTo use this access mode, use the following security pattern: [Application-restricted RESTful APIs - signed 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| Environment | Base Url |\n|-------------|----------|\n| Integration | https://int.api.service.nhs.uk/pathology-laboratory-reporting |\n\nOur [integration](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing) test environment:\n- is for formal integration testing\n- is stateful, so persists updates\n- includes security and authorisation restrictions\n\nTo use our integration test environment:\n- use the [instructions](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis) to setup an application in our integration test environment\n- contact us with your application ID, application name and NHS product ID\n\n## Onboarding\nYou need to get your software approved by us before it can go live with this API.\n\nThis API is currently in Private Beta with restricted onboarding by invite only.\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\nOn error we return a FHIR [OperationOutcome](https://build.fhir.org/operationoutcome.html) resource. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors and [error handling](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#error-handling), including retries.\nWhere an error is returned, when retrying a request the same X-Request-ID value must be provided for each retry attempt.\n","termsOfService":null,"contact":{"name":"API Support","url":null,"email":null},"license":null,"version":"0.1.0"},"servers":[{"url":"https://int.api.service.nhs.uk/pathology-laboratory-reporting","description":"Integration environment","variables":null}],"paths":{"/FHIR/R4/Bundle":{"$ref":null,"summary":null,"description":null,"get":null,"put":null,"post":{"tags":null,"summary":"Send a laboratory test report","description":"Use this endpoint to send a FHIR [Document Bundle](https://hl7.org/fhir/R4/bundle.html) to the API.\n\nThe bundle type must be `document` (https://hl7.org/fhir/R4/bundle-definitions.html#Bundle.type). All other bundle types are not supported.\n\nThe request bundle must:\n\n- have type `document`\n- contain a `Composition` resource as the first entry in the bundle\n- contain exactly one `DiagnosticReport` resource\n- specify an identifier for the calling application in the format \\:\\<(Optional) Test Reporter identifier>, found at Provenance.agent.who.identifier.value\n- specify the ODS code of requesting practitioners organisation, either:\n - directly via a `ServiceRequest` resource:\n - DiagnosticReport.basedOn, which references one or more `ServiceRequest` resources\n - ServiceRequest.requester which references an `Organization` resource\n - Organization.identifier\n - or indirectly via a `PractitionerRole` resource:\n - DiagnosticReport.basedOn, which references one or more `ServiceRequest` resources\n - ServiceRequest.requester which references a `PractitionerRole` resource\n - PractitionerRole.organisation, which references an `Organization` resource\n - Organization.identifier\n - Note that only a single ODS code for the requesting organisation may be defined. Where multiple `ServiceRequest` resources are referenced from DiagnosticReport.basedOn, the Organization.identifier associated with each `ServiceRequest` must specify the same value. Requests that yield multiple distinct ODS codes for the requesting organisation will be rejected.\n- specify the Patient's NHS Number, found at Composition.subject.identifier.value\n- conform with the guidance and requirements outlined in the [NHS England Pathology FHIR Implementation Guide](https://simplifier.net/guide/pathology-fhir-implementation-guide)\n- have each entry specifying a fullUrl\n","externalDocs":null,"operationId":"postBundle","parameters":[{"description":"Defines a unique identifier for the current business transaction. This value should be consistent across all requests and responses made within a given business transaction, and can be used to correlate requests and responses across multiple systems.\n\nWhen calling this endpoint, if performing the operation as part of a transaction originating from another system, an existing business transaction identifier should be specified as this header's value if available.\nIf no existing business transaction identifier is available, or if the existing business transaction identifier is not in the required format, a new UUID should be generated and specified as this header's value.\n","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"b876145d-1ebf-4e22-8ff8-275b570c1ec4","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Defines a unique identifier for the current request. This value should be unique per request made to this endpoint, however when retrying a request the same `X-Request-ID` value must be provided.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abafd190-3678-425c-94f5-d1d7dc595142","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false}],"requestBody":{"description":null,"content":{"application/fhir+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","type","entry"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Bundle"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"FHIR resource type","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"meta":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":[{"$ref":"#/components/schemas/meta"}],"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Metadata for the Bundle resource. The `security` field must not be included; security labels are applied by the API and any request that includes `meta.security` will be rejected with a `400` response.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["document"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The type of the bundle","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"document","deprecated":null},"entry":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["fullUrl","resource"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"fullUrl":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"URI for resource","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"composition","deprecated":null},"resource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":null,"allOf":null,"oneOf":null,"anyOf":[{"$ref":"#/components/schemas/CompositionResource"},{"$ref":"#/components/schemas/DiagnosticReportResource"},{"$ref":"#/components/schemas/ServiceRequestResource"},{"$ref":"#/components/schemas/PractitionerRoleResource"},{"$ref":"#/components/schemas/OrganizationResource"},{"$ref":"#/components/schemas/ProvenanceResource"},{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Patient","Observation","Specimen","Practitioner"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (e.g. \"Patient\", \"Observation\", etc.)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Patient","deprecated":null},"id":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"meta":{"$ref":"#/components/schemas/meta"},"extension":{"$ref":"#/components/schemas/extension"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}],"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":"Entries that form a Test Report. Any included entries should comply with the [Pathology FHIR Implementation Guide](https://simplifier.net/guide/pathology-fhir-implementation-guide/Home), though the following resources and fields are specifically required when calling this endpoint:\n| Resource Type | Required Fields |\n|------------------|-----------------|\n| Composition | - `subject` - Required to identify the Patient a given Test Report is for. The `Subject` should include an `identifier` referencing the `https://fhir.nhs.uk/Id/nhs-number` `system` value. |\n| DiagnosticReport | - `basedOn` - Identifies one or more ServiceRequests contained within the Test Report. This field should be a [Literal Reference](https://hl7.org/fhir/R4/references.html#literal) to one or more ServiceRequest resources within this `Bundle`. |\n| ServiceRequest | - `requester` - Identifies the requester of a given test. This field should be a [Literal Reference](https://hl7.org/fhir/R4/references.html#literal) to a `PractitionerRole`or `Organization` resource within this `Bundle`. |\n| PractitionerRole | - `organization` - When referenced from ServiceRequest.requester, identifies the organization that requested a given test. This field should be a [Literal Reference](https://hl7.org/fhir/R4/references.html#literal) to an `Organization` resource within this `Bundle`. |\n| Organization | - `identifier` - Indicates the [ODS](https://digital.nhs.uk/services/organisation-data-service#top) code for the organisation that requested a given test. This field should include an identifier utilising the `system` value of `https://fhir.nhs.uk/Id/ods-organization-code`. |\n| Provenance | - `activity` - There should be a single `Provenance` resource with the coding as transform
- `target` - should reference the `Composition` resource
- `agent.who` - Identifier for the calling application. The `Who` should include an `identifier` referencing the `https://api.service.nhs.uk/pathology-laboratory-reporting/test-reporting-system` `system` value. |\n","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":{"resourceType":"Bundle","type":"document","entry":[{"fullUrl":"composition","resource":{"resourceType":"Composition","subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}}}},{"fullUrl":"ServiceRequest","resource":{"resourceType":"ServiceRequest","requester":{"reference":"PractitionerRole"}}},{"fullUrl":"PractitionerRole","resource":{"resourceType":"PractitionerRole","organization":{"reference":"Organization"}}},{"fullUrl":"Organization","resource":{"resourceType":"Organization","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"A12345"}]}},{"fullUrl":"Patient","resource":{"resourceType":"Patient"}},{"fullUrl":"DiagnosticReport","resource":{"resourceType":"DiagnosticReport","basedOn":[{"reference":"ServiceRequest"}]}},{"fullUrl":"Practitioner","resource":{"resourceType":"Practitioner"}},{"fullUrl":"Observation","resource":{"resourceType":"Observation"}},{"fullUrl":"Provenance","resource":{"resourceType":"Provenance","activity":{"coding":[{"system":"http://hl7.org/fhir/v3/ProvenanceActivity","code":"transform"}]},"target":[{"reference":"Composition"}],"agent":[{"who":{"identifier":{"system":"https://api.service.nhs.uk/pathology-laboratory-reporting/test-reporting-system","value":"P.GH7-4TY"}}}]}}]},"deprecated":null},"example":null,"examples":null,"encoding":null}},"required":true},"responses":{"200":{"description":"Successful response","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","type"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Bundle"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"FHIR resource type (always \"Bundle\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"meta":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"versionId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Version identifier for the resource","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"lastUpdated":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Timestamp of when the Test Report was created.","format":"date-time","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"tag":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"system":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":"Tags applied to the resource","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":"Metadata about the resource","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["document","transaction"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The type of the bundle","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"identifier":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"system":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"value":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":"Persistent identifier for the bundle (UUID)","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"entry":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["fullUrl","resource"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"fullUrl":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"URI for resource","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"resource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":"Entries in the bundle","format":null,"default":null,"nullable":true,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"Example success response":{"summary":"Example success response","description":null,"value":{"id":"f0f87d08-e5e9-4b28-a0ae-f5a8c6df01b4","meta":{"versionId":"1","lastUpdated":"2024-01-01T12:00:00Z","tag":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"NOPAT"}]},"resourceType":"Bundle","type":"document","entry":[{"fullUrl":"composition","resource":{"resourceType":"Composition","subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}}}},{"fullUrl":"ServiceRequest","resource":{"resourceType":"ServiceRequest","requester":{"reference":"PractitionerRole"}}},{"fullUrl":"PractitionerRole","resource":{"resourceType":"PractitionerRole","organization":{"reference":"Organization"}}},{"fullUrl":"Organization","resource":{"resourceType":"Organization","identifier":[{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"A12345"}]}},{"fullUrl":"Patient","resource":{"resourceType":"Patient"}},{"fullUrl":"DiagnosticReport","resource":{"resourceType":"DiagnosticReport","basedOn":[{"reference":"ServiceRequest"}]}},{"fullUrl":"Practitioner","resource":{"resourceType":"Practitioner"}},{"fullUrl":"Observation","resource":{"resourceType":"Observation"}},{"fullUrl":"Provenance","resource":{"resourceType":"Provenance"}}]},"externalValue":null}},"encoding":null}},"links":null},"400":{"description":"Malformed request","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Unprocessible Request Body response":{"summary":"Example OperationOutcome response for unprocessable request body","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Malformed request body. Ensure that supplied request bodies are well-formed JSON."}]},"externalValue":null}},"encoding":null}},"links":null},"422":{"description":"Invalid Request Content","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Validation Error response":{"summary":"Example OperationOutcome response for invalid request","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Resources must be provided as a bundle of type document"}]},"externalValue":null},"Example meta.tag rejected response":{"summary":"Example OperationOutcome response when meta.tag is present","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Bundles must not include meta.tag; tags are applied by the API"}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Too Many Requests response":{"summary":"Example OperationOutcome response for too many requests","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"throttled","diagnostics":"Too many requests have been made to this API. Please try again later."}]},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Unexpected internal error","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Internal Error response":{"summary":"Example OperationOutcome response for unexpected internal error","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"exception","diagnostics":"An unexpected error has occurred whilst processing your request."}]},"externalValue":null}},"encoding":null}},"links":null},"502":{"description":"Bad Gateway","headers":null,"content":null,"links":null},"503":{"description":"Service temporarily unavailable","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Service Unavailable response":{"summary":"Example OperationOutcome response for service temporarily unavailable","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"An unexpected internal error has occurred"}]},"externalValue":null}},"encoding":null}},"links":null},"401":{"description":"Unauthorized request","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":null,"links":null},"403":{"description":"Forbidden request","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Forbidden response":{"summary":"Example optional OperationOutcome response for forbidden request","description":"A response body may optionally be returned","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","diagnostics":"The calling application is not authorised to access this environment."}]},"externalValue":null}},"encoding":null}},"links":null},"409":{"description":"Request ID Conflict","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Request ID Conflict response":{"summary":"Example OperationOutcome response for request ID conflict","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"conflict","diagnostics":"The provided X-Request-ID has already been used to send a different Test Report."}]},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":[{"app-level3":[]}],"servers":null},"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null},"/FHIR/R4/Bundle/{resource_id}":{"$ref":null,"summary":null,"description":null,"get":{"tags":null,"summary":"Retrieve a test report acknowledgement","description":"Use this endpoint to get a specific resource using its resource id.\n\nYou will only be able to retrieve a resource that is a Pathology and Laboratory Medicine test report acknowledgement.\n","externalDocs":null,"operationId":"getBundleAcknowledgement","parameters":[{"description":"The identifier of the Bundle acknowledgement to retrieve.","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":null,"content":null,"name":"resource_id","in":"path","allowEmptyValue":false,"allowReserved":false},{"description":"Defines a unique identifier for the current business transaction. This value should be consistent across all requests and responses made within a given business transaction, and can be used to correlate requests and responses across multiple systems.\nWhen calling this endpoint, if performing the operation as part of a transaction originating from another system, an existing business transaction identifier should be specified as this header's value if available. If no existing business transaction identifier is available, or if the existing business transaction identifier is not in the required format, a new UUID should be generated and specified as this header's value.\n","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"b876145d-1ebf-4e22-8ff8-275b570c1ec4","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Correlation-ID","in":"header","allowEmptyValue":false,"allowReserved":false},{"description":"Defines a unique identifier for the current request. This value should be unique per request made to this endpoint, however when retrying a request the same X-Request-ID value must be provided.\n","required":true,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uuid","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"abafd190-3678-425c-94f5-d1d7dc595142","deprecated":null},"example":null,"examples":null,"content":null,"name":"X-Request-ID","in":"header","allowEmptyValue":false,"allowReserved":false}],"requestBody":null,"responses":{"200":{"description":"Successful response","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"},"ETag":{"description":"Version identifier for the retrieved Bundle resource.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"W/\"1\"","deprecated":null},"example":null,"examples":null,"content":null}},"content":{"application/fhir+json":{"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","type","entry"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Bundle"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"FHIR resource type (always \"Bundle\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"type":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["message"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"The type of the bundle (always \"message\" for acknowledgements)","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"entry":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["fullUrl","resource"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"fullUrl":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"URI for the resource","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"resource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":"Entries in the acknowledgement bundle","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":{"Example acknowledgement bundle response":{"summary":"Example acknowledgement bundle returned by PDM","description":null,"value":{"resourceType":"Bundle","type":"message","entry":[{"fullUrl":"urn:uuid:a1b2c3d4-e5f6-7890-abcd-ef1234567890","resource":{"resourceType":"MessageHeader","eventCoding":{"system":"https://fhir.nhs.uk/CodeSystem/message-event","code":"pathology-laboratory-reporting-test-result-stored-1-ack-1"}}}]},"externalValue":null}},"encoding":null}},"links":null},"400":{"description":"Invalid request","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example invalid resource response":{"summary":"Example OperationOutcome response for an invalid resource","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Invalid resource: resource_id [resource_id] is not a pathology and laboratory medicine test report acknowledgement."}]},"externalValue":null}},"encoding":null}},"links":null},"401":{"description":"Unauthorized request","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":null,"links":null},"403":{"description":"Forbidden request","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Forbidden response":{"summary":"Example optional OperationOutcome response for forbidden request","description":"A response body may optionally be returned","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","diagnostics":"The calling application is not authorised to access this environment."}]},"externalValue":null}},"encoding":null}},"links":null},"404":{"description":"Resource not found","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example not found response":{"summary":"Example OperationOutcome when the requested resource does not exist","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","diagnostics":"Resource not found."}]},"externalValue":null}},"encoding":null}},"links":null},"429":{"description":"Too many requests - rate limit exceeded","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example rate limit response":{"summary":"Example OperationOutcome when too many requests have been made","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"throttled","diagnostics":"Too many requests have been made to this API. Please try again later."}]},"externalValue":null}},"encoding":null}},"links":null},"500":{"description":"Unexpected internal error","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example Internal Error response":{"summary":"Example OperationOutcome response for unexpected internal error","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"exception","diagnostics":"An unexpected error has occurred whilst processing your request."}]},"externalValue":null}},"encoding":null}},"links":null},"503":{"description":"Service temporarily unavailable","headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-ID"}},"content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"},"example":null,"examples":{"Example service unavailable response":{"summary":"Example OperationOutcome when the upstream service is temporarily unavailable","description":null,"value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"transient","diagnostics":"The Pathology API is temporarily unavailable. Please try again later."}]},"externalValue":null}},"encoding":null}},"links":null}},"callbacks":null,"deprecated":false,"security":[{"app-level3":[]}],"servers":null},"put":null,"post":null,"delete":null,"options":null,"head":null,"patch":null,"trace":null,"servers":null,"parameters":null}},"components":{"schemas":{"meta":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"profile":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"versionId":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"extension":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["url"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"url":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"CompositionResource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","subject"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Composition"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (always \"Composition\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Composition","deprecated":null},"meta":{"$ref":"#/components/schemas/meta"},"subject":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["identifier"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"identifier":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["system","value"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"system":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"https://fhir.nhs.uk/Id/nhs-number","deprecated":null},"value":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"9999999999","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"DiagnosticReportResource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","basedOn"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["DiagnosticReport"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (always \"DiagnosticReport\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"DiagnosticReport","deprecated":null},"basedOn":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":1,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["reference"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"reference":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A Literal Reference to a ServiceRequest resource within the current Bundle. This provided reference should resolve to the `fullUrl` of a ServiceRequest entry within the current Bundle.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"urn:uuid:8a6d85b8-9837-4fed-a257-4cf207988338","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ServiceRequestResource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","requester"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"meta":{"$ref":"#/components/schemas/meta"},"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["ServiceRequest"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (always \"ServiceRequest\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"ServiceRequest","deprecated":null},"requester":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["reference"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"reference":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A Literal Reference to either a PractitionerRole or Organization resource within the current Bundle. This provided reference should resolve to the `fullUrl` of a PractitionerRole or Organization entry within the current Bundle.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"urn:uuid:8a6d85b8-9837-4fed-a257-4cf207988338","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"PractitionerRoleResource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","organization"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"meta":{"$ref":"#/components/schemas/meta"},"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["PractitionerRole"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (always \"PractitionerRole\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"PractitionerRole","deprecated":null},"organization":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["reference"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"reference":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A Literal Reference to an `Organization` resource within the current Bundle. This provided reference should resolve to the `fullUrl` of an `Organization` entry within the current Bundle.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"urn:uuid:7cbbacfa-1b8c-4d9e-9c5a-8fbbacfa1b8c","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"OrganizationResource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","identifier"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"meta":{"$ref":"#/components/schemas/meta"},"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Organization"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (always \"Organization\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Organization","deprecated":null},"identifier":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":1,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["system","value"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"system":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["https://fhir.nhs.uk/Id/ods-organization-code"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"https://fhir.nhs.uk/Id/ods-organization-code","deprecated":null},"value":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"ODS code of the requesting organisation","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"A12345","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"ProvenanceResource":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","activity","target","agent"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["Provenance"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Type of FHIR resource (always \"Provenance\")","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"Provenance","deprecated":null},"meta":{"$ref":"#/components/schemas/meta"},"activity":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["coding"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"coding":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":1,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["system","code"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"system":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"http://example.com/system","deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["transform"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"transform","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"target":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":1,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["reference"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"reference":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"A Literal Reference to the Composition resource within the current Bundle. This provided reference should resolve to the `fullUrl` of a Composition entry within the current Bundle.","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"composition","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"agent":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["who"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"who":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["identifier"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"identifier":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["system","value"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"system":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["https://api.service.nhs.uk/pathology-laboratory-reporting/test-reporting-system"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":"uri","default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"https://api.service.nhs.uk/pathology-laboratory-reporting/test-reporting-system","deprecated":null},"value":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":"Identifier for the system that generated the Test Report","format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"P.GH7-4TY","deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"OperationOutcome":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["resourceType","issue"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"resourceType":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["OperationOutcome"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"OperationOutcome","deprecated":null},"issue":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"array","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":["severity","code","diagnostics"],"enum":null,"type":"object","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":{"severity":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["fatal","error","information"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"error","deprecated":null},"code":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":["invalid","conflict","exception","not-found","throttled","transient","informational","forbidden"],"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":"invalid","deprecated":null},"diagnostics":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null}},"responses":null,"parameters":null,"examples":null,"requestBodies":null,"headers":{"X-Correlation-ID":{"description":"Echoes the value provided within the `X-Correlation-ID` request header.","required":false,"deprecated":false,"style":null,"explode":false,"schema":{"title":null,"multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"enum":null,"type":"string","allOf":null,"oneOf":null,"anyOf":null,"not":null,"items":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"default":null,"nullable":null,"discriminator":null,"readOnly":null,"writeOnly":null,"xml":null,"externalDocs":null,"example":null,"deprecated":null},"example":null,"examples":null,"content":null}},"securitySchemes":{"app-level3":{"$ref":"https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/app-level3"}},"links":null,"callbacks":null},"security":null,"tags":null,"externalDocs":null,"x-nhsd-apim":null,"x-spec-publication":null}