openapi: 3.0.0

# This is an OpenAPI Specification (https://swagger.io/specification/)

# for the National Record Locator Consumer FHIR API

# owned by NHS Digital (https://digital.nhs.uk/)

info:

title: National Record Locator Consumer - FHIR API

version: 1.0.0

license:

name: MIT

contact:

name: NHS Digital API Management

url: "https://digital.nhs.uk/developer/help-and-support"

email: [email protected]

servers:

- url: https://sandbox.api.service.nhs.uk/record-locator/consumer/FHIR/R4

description: Sandbox environment.

- url: https://int.api.service.nhs.uk/record-locator/consumer/FHIR/R4

description: Integration test environment.

- url: https://api.service.nhs.uk/record-locator/consumer/FHIR/R4

description: Production environment.

tags:

paths:

/DocumentReference:

get:

tags:

summary: Retrieve patient's document pointers (GET)

operationId: searchDocumentReference

parameters:

- $ref: "#/components/parameters/subject"

- $ref: "#/components/parameters/custodian"

- $ref: "#/components/parameters/type"

- $ref: "#/components/parameters/category"

- $ref: "#/components/parameters/nextPageToken"

- $ref: "#/components/parameters/odsCode"

- $ref: "#/components/parameters/requestId"

- $ref: "#/components/parameters/correlationId"

responses:

"200":

description: Successful response

content:

application/fhir+json:

schema:

$ref: "#/components/schemas/Bundle"

example:

resourceType: Bundle

type: searchset

total: 1

entry:

- resource:

resourceType: DocumentReference

id: Y05868-1634567890

meta:

profile:

- http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0

masterIdentifier:

system: urn:ietf:rfc:3986

value: urn:oid:1.3.6.1.4.1.21367.2005.3.7

identifier:

- system: urn:ietf:rfc:3986

value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234

status: current

docStatus: preliminary

type:

coding:

- system: http://snomed.info/sct

code: "736253002"

display: Mental health crisis plan

category:

- coding:

- system: http://loinc.org

code: 34108-1

display: Outpatient Note

subject:

identifier:

system: https://fhir.nhs.uk/Id/nhs-number

value: "9000000017"

date: "2022-12-20T09:45:41+11:00"

author:

- identifier:

value: Practitioner/A985657ZA

authenticator:

identifier:

value: Organization/Y05868

custodian:

identifier:

system: https://fhir.nhs.uk/Id/ods-organization-code

value: Y05868

description: Physical

securityLabel:

- coding:

- system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality

code: V

display: very restricted

content:

- attachment:

contentType: application/pdf

language: en-US

url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/MentalHealthCrisisPlan.pdf

hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk=

title: Physical

creation: "2022-12-20T09:45:41+11:00"

format:

system: urn:oid:1.3.6.1.4.1.19376.1.2.3

code: urn:ihe:pcc:handp:2008

display: History and Physical Specification

context:

event:

- coding:

- system: http://snomed.info/sct

code: "445627002"

display: Assessment using adult early warning scoring system

period:

start: "2022-12-20T09:00:41+11:00"

end: "2022-12-20T09:45:41+11:00"

facilityType:

coding:

- system: http://snomed.info/sct

code: "82242000"

display: Children's hospital

practiceSetting:

coding:

- system: http://snomed.info/sct

code: "788002001"

display: Adult mental health service

related:

- identifier:

system: https://fhir.nhs.uk/Id/nhsSpineASID

value: "200000000610"

headers:

X-Correlation-Id:

$ref: "#/components/headers/CorrelationId"

X-Request-Id:

$ref: "#/components/headers/RequestId"

x-amazon-apigateway-integration:

type: aws_proxy

httpMethod: POST

uri: ${method_searchDocumentReference}

responses:

default:

statusCode: "200"

passthroughBehavior: when_no_match

contentHandling: CONVERT_TO_TEXT

description: |

Retrieve the document pointers for a single patient. Your request is constrained by the document pointer types

agreed during onboarding. The results can also be filtered to return documents by a given `type` and/or created

by a given producer (`custodian`).

This operation is also available as a http POST, which is the preferred method (see below).

/DocumentReference/_search:

post:

tags:

summary: Retrieve patient's document pointers (POST)

operationId: searchPostDocumentReference

parameters:

- $ref: "#/components/parameters/odsCode"

- $ref: "#/components/parameters/requestId"

- $ref: "#/components/parameters/correlationId"

requestBody:

content:

application/json:

schema:

$ref: "#/components/schemas/RequestParams"

responses:

"200":

description: Search successful response

content:

application/fhir+json:

schema:

$ref: "#/components/schemas/Bundle"

example:

resourceType: Bundle

type: searchset

total: 1

entry:

- resource:

resourceType: DocumentReference

id: Y05868-1234567895

meta:

profile:

- http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0

masterIdentifier:

system: urn:ietf:rfc:3986

value: urn:oid:1.3.6.1.4.1.21367.2005.3.9

identifier:

- system: urn:ietf:rfc:3986

value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1239

status: current

docStatus: final

type:

coding:

- system: http://snomed.info/sct

code: "736253002"

display: Mental Health Crisis Plan

category:

- coding:

- system: http://loinc.org

code: 55112-7

display: Document summary

subject:

identifier:

system: https://fhir.nhs.uk/Id/nhs-number

value: "9000000017"

date: "2022-12-21T10:45:41+11:00"

author:

- identifier:

value: Practitioner/A985657ZA

authenticator:

identifier:

value: Organization/Y05868

custodian:

identifier:

system: https://fhir.nhs.uk/Id/ods-organization-code

value: Y05868

description: Physical

securityLabel:

- coding:

- system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality

code: V

display: very restricted

content:

- attachment:

contentType: application/pdf

language: en-US

url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EOLSummaryReport.pdf

size: 4000

hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk=

title: Physical

creation: "2021-12-21T10:45:41+11:00"

format:

system: urn:oid:1.3.6.1.4.1.19376.1.2.3

code: urn:ihe:pcc:cm:2008

display: Care Management

context:

- event:

- coding:

system: http://snomed.info/sct

code: "445627002"

display: Assessment using adult early warning scoring system

- period:

start: "2022-12-20T09:00:41+11:00"

end: "2022-12-20T09:45:41+11:00"

- facilityType:

- coding:

system: http://snomed.info/sct

code: "82242000"

display: Children's hospital

- practiceSetting:

- coding:

system: http://snomed.info/sct

code: "788002001"

display: Adult mental health service

- related:

- identifier:

system: https://fhir.nhs.uk/Id/nhsSpineASID

value: "200000000610"

headers:

X-Correlation-Id:

$ref: "#/components/headers/CorrelationId"

X-Request-Id:

$ref: "#/components/headers/RequestId"

x-amazon-apigateway-integration:

type: aws_proxy

httpMethod: POST

uri: ${method_searchPostDocumentReference}

responses:

default:

statusCode: "200"

passthroughBehavior: when_no_match

contentHandling: CONVERT_TO_TEXT

description: |

Retrieve the document pointers for a single patient. Your request is constrained by the document pointer types

agreed during onboarding. The results can also be filtered to return documents by a given `type` and/or created

by a given `custodian`.

This operation is also available as a http GET for convenience (see above), but POST is preferred for the

following reasons.

* query string parameters are visible on the network and in logs, and may have privacy implications for consumers.

* GET operations can be cached by intermediary network infrastructure, such as CDNs, routers and proxies.

* URLs have a maximum length of 2,048 characters which complex searches can exceed. NRL does not currently

exceed this limit, but may evolve in the future.

/DocumentReference/{id}:

get:

tags:

summary: Get a single document pointer

operationId: readDocumentReference

parameters:

- $ref: "#/components/parameters/id"

- $ref: "#/components/parameters/odsCode"

- $ref: "#/components/parameters/requestId"

- $ref: "#/components/parameters/correlationId"

responses:

"200":

description: Search successful response

content:

application/fhir+json:

schema:

$ref: "#/components/schemas/DocumentReference"

example:

resourceType: DocumentReference

id: Y05868-1234567892

status: current

docStatus: final

type:

coding:

- system: http://snomed.info/sct

code: "887701000000100"

display: Emergency health care plan

category:

- coding:

- system: http://loinc.org

code: 68552-9

display: Emergency medicine Emergency department Admission evaluation note

subject:

identifier:

system: https://fhir.nhs.uk/Id/nhs-number

value: "9000000017"

date: "2022-12-22T11:45:41+11:00"

author:

- identifier:

value: Practitioner/A985657ZA

authenticator:

identifier:

value: Organization/Y05868

custodian:

identifier:

system: https://fhir.nhs.uk/Id/ods-organization-code

value: Y05868

securityLabel:

- coding:

- system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality

code: V

display: very restricted

content:

- attachment:

contentType: application/pdf

language: en-US

url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EmergencyHealthPlan.pdf

creation: "2022-12-22T09:45:41+11:00"

format:

system: urn:oid:1.3.6.1.4.1.19376.1.2.3

code: urn:ihe:pcc:handp:2008

display: History and Physical Specification

context:

- event:

- coding:

system: http://snomed.info/sct

code: "445627002"

display: Assessment using adult early warning scoring system

- period:

start: "2022-12-20T09:00:41+11:00"

end: "2022-12-20T09:45:41+11:00"

- facilityType:

- coding:

system: http://snomed.info/sct

code: "82242000"

display: Children's hospital

- practiceSetting:

- coding:

system: http://snomed.info/sct

code: "788002001"

display: Adult mental health service

- related:

- identifier:

system: https://fhir.nhs.uk/Id/nhsSpineASID

value: "200000000610"

headers:

X-Correlation-Id:

$ref: "#/components/headers/CorrelationId"

X-Request-Id:

$ref: "#/components/headers/RequestId"

x-amazon-apigateway-integration:

type: aws_proxy

httpMethod: POST

uri: ${method_readDocumentReference}

responses:

default:

statusCode: "200"

passthroughBehavior: when_no_match

contentHandling: CONVERT_TO_TEXT

description: |

Read a single document pointer by specifying the `DocumentReference.id`. Note that you will only be able to

retrieve document pointers that have the `type` that was agreed during the [onboarding](#api-description__onboarding) process.

/metadata:

get:

summary: Retrieve FHIR Capability Statement

operationId: getCapabilityStatement

responses:

"200":

description: Capability statement response

content:

application/json:

schema:

type: object

x-amazon-apigateway-integration:

type: MOCK

requestTemplates:

application/json: '{ "statusCode": 200 }'

responses:

default:

statusCode: "200"

responseTemplates:

# prettier-ignore

application/json: '${capability_statement_json}'

/_status:

get:

tags:

summary: _status endpoint for APIGEE integration

operationId: status

responses:

"200":

description: Consumer API is operational

content:

application/json:

schema:

type: object

properties:

message:

type: string

enum: ["OK"]

x-amazon-apigateway-integration:

type: aws_proxy

httpMethod: POST

uri: ${method_status}

responses:

default:

statusCode: "200"

passthroughBehavior: when_no_match

contentHandling: CONVERT_TO_TEXT

components:

requestBodies:

DocumentReference:

content:

application/fhir+json:

schema:

$ref: "#/components/schemas/DocumentReference"

required: true

schemas:

OperationOutcome:

type: object

properties:

resourceType:

type: string

enum:

- OperationOutcome

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta:

$ref: "#/components/schemas/Meta"

description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules:

type: string

pattern: \S*

description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: The base language in which the resource is written.

text:

$ref: "#/components/schemas/Narrative"

description: A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

issue:

type: array

items:

$ref: "#/components/schemas/OperationOutcomeIssue"

description: An error, warning, or information message that results from a system action.

minItems: 1

required:

- resourceType

- issue

OperationOutcomeIssue:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

severity:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: Indicates whether the issue indicates a variation from successful processing.

code:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

details:

$ref: "#/components/schemas/CodeableConcept"

description: Additional details about the error. This may be a text description of the error or a system code that identifies the error.

diagnostics:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: Additional diagnostic information about the issue.

location:

type: array

items:

type: string

pattern: "[ \\r\\n\\t\\S]+"

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:

type: string

pattern: "[ \\r\\n\\t\\S]+"

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.

required:

- severity

- code

DocumentReference:

type: object

properties:

resourceType:

type: string

enum:

- DocumentReference

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta:

$ref: "#/components/schemas/Meta"

description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules:

type: string

pattern: \S*

description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: The base language in which the resource is written.

text:

$ref: "#/components/schemas/Narrative"

description: A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

masterIdentifier:

$ref: "#/components/schemas/Identifier"

description: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

identifier:

type: array

items:

$ref: "#/components/schemas/Identifier"

description: Other identifiers associated with the document, including version independent identifiers.

status:

type: string

pattern: "^current$"

description: The status of this document reference.

docStatus:

type: string

enum: ["entered-in-error", "amended", "preliminary", "final"]

description: The status of the underlying document.

type:

$ref: "#/components/schemas/CodeableConcept"

description: Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

category:

type: array

items:

$ref: "#/components/schemas/CodeableConcept"

description: A categorization for the type of document referenced – helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

subject:

$ref: "#/components/schemas/Reference"

description: Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

date:

type: string

pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))

description: When the document reference was created.

author:

type: array

items:

$ref: "#/components/schemas/Reference"

description: Identifies who is responsible for adding the information to the document.

authenticator:

$ref: "#/components/schemas/Reference"

description: Which person or organization authenticates that this document is valid.

custodian:

$ref: "#/components/schemas/Reference"

description: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

relatesTo:

type: array

items:

$ref: "#/components/schemas/DocumentReferenceRelatesTo"

description: Relationships that this document has with other document references that already exist.

description:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: Human–readable description of the source document.

securityLabel:

type: array

items:

$ref: "#/components/schemas/CodeableConcept"

description: A set of Security–Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

content:

type: array

items:

$ref: "#/components/schemas/DocumentReferenceContent"

description: The document and format referenced. There may be multiple content element repetitions, each with a different format.

minItems: 1

context:

$ref: "#/components/schemas/DocumentReferenceContext"

description: The clinical context in which the document was prepared.

required:

- resourceType

- status

- content

Bundle:

type: object

properties:

resourceType:

type: string

enum:

- Bundle

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta:

$ref: "#/components/schemas/Meta"

description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules:

type: string

pattern: \S*

description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: The base language in which the resource is written.

identifier:

$ref: "#/components/schemas/Identifier"

description: A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

type:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: Indicates the purpose of this bundle – how it is intended to be used.

timestamp:

type: string

pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))

description: The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle.

total:

type: integer

format: int32

description: If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

link:

type: array

items:

$ref: "#/components/schemas/BundleLink"

description: A series of links that provide context to this bundle.

entry:

type: array

items:

$ref: "#/components/schemas/BundleEntry"

description: An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only).

signature:

$ref: "#/components/schemas/Signature"

description: Digital Signature – base64 encoded. XML–DSig or a JWT.

required:

- resourceType

- type

BundleEntry:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

link:

type: array

items:

$ref: "#/components/schemas/BundleLink"

description: A series of links that provide context to this entry.

fullUrl:

type: string

pattern: \S*

description: "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified."

resource:

oneOf:

- $ref: "#/components/schemas/DocumentReference"

- $ref: "#/components/schemas/OperationOutcome"

description: The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

search:

$ref: "#/components/schemas/BundleEntrySearch"

description: Information about the search process that lead to the creation of this entry.

request:

$ref: "#/components/schemas/BundleEntryRequest"

description: Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

response:

$ref: "#/components/schemas/BundleEntryResponse"

description: Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

BundleEntryResponse:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

status:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

location:

type: string

pattern: \S*

description: The location header created by processing this operation, populated if the operation returns a location.

etag:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).

lastModified:

type: string

pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))

description: The date/time that the resource was modified on the server.

outcome:

$ref: "#/components/schemas/DocumentReference"

description: An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

required:

- status

BundleEntryRequest:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

method:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

url:

type: string

pattern: \S*

description: The URL for this entry, relative to the root (the address to which the request is posted).

ifNoneMatch:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).

ifModifiedSince:

type: string

pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))

description: Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).

ifMatch:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).

ifNoneExist:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL – what follows the "?" (not including the "?").

required:

- method

- url

BundleEntrySearch:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

mode:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

score:

type: number

description: When searching, the server's search ranking score for the entry.

BundleLink:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

relation:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1).

url:

type: string

pattern: \S*

description: The reference details for the link.

required:

- relation

- url

DocumentReferenceContext:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

encounter:

type: array

items:

$ref: "#/components/schemas/Reference"

description: Describes the clinical encounter or type of care that the document content is associated with.

event:

type: array

items:

$ref: "#/components/schemas/CodeableConcept"

description: This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

period:

$ref: "#/components/schemas/Period"

description: The time period over which the service that is described by the document was provided.

facilityType:

$ref: "#/components/schemas/CodeableConcept"

description: The kind of facility where the patient was seen.

practiceSetting:

$ref: "#/components/schemas/CodeableConcept"

description: This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

sourcePatientInfo:

$ref: "#/components/schemas/Reference"

description: The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

related:

type: array

items:

$ref: "#/components/schemas/Reference"

description: Related identifiers or resources associated with the DocumentReference.

required:

- practiceSetting

DocumentReferenceContent:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

attachment:

$ref: "#/components/schemas/Attachment"

description: The document or URL of the document along with critical metadata to prove content has integrity.

format:

$ref: "#/components/schemas/NRLFormatCode"

description: An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

extension:

type: array

items:

oneOf:

- $ref: "#/components/schemas/ContentStabilityExtension"

- $ref: "#/components/schemas/NRLRetrievalMechanismExtension"

- $ref: "#/components/schemas/Extension"

description: Additional extensions which include Content Stability and Retrieval Mechanism.

minItems: 1

required:

- attachment

- format

- extension

DocumentReferenceRelatesTo:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

code:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: The type of relationship that this document has with anther document.

target:

$ref: "#/components/schemas/Reference"

description: The target document of this relationship.

required:

- code

- target

Attachment:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

contentType:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

language:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: The human language of the content. The value can be any valid value according to BCP 47.

data:

type: string

pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+

description: The actual data of the attachment – a sequence of bytes, base64 encoded.

url:

type: string

pattern: \S*

description: A location where the data can be accessed.

size:

type: integer

format: int32

description: The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

hash:

type: string

pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+

description: The calculated hash of the data using SHA–1. Represented using base64.

title:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: A label or set of text to display in place of the data.

creation:

type: string

pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?

description: The date that the attachment was first created.

required:

- contentType

- url

CodeableConcept:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

coding:

type: array

items:

$ref: "#/components/schemas/Coding"

description: A reference to a code defined by a terminology system.

text:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Coding:

type: object

properties:

id:

type: string

pattern: "[A-Za-z0-9\\-\\.]{1,64}"

description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

system:

type: string

pattern: \S*

description: The identification of the code system that defines the meaning of the symbol in the code.

version:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

code:

type: string

pattern: "[^\\s]+(\\s[^\\s]+)*"

description: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination).

display:

type: string

pattern: "[ \\r\\n\\t\\S]+"

description: A representation of the meaning of the code in the system, following the rules of the system.

userSelected:

type: boolean

description: Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays).

Extension:

type: object

properties:

valueCodeableConcept:

$ref: "#/components/schemas/CodeableConcept"

description: A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1).

url:

type: string

pattern: \S*

description: The reference details for the link.

ContentStabilityExtension:

allOf:

- $ref: "#/components/schemas/Extension"

- type: object

properties:

url:

type: string

enum:

- "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"

valueCodeableConcept:

$ref: "#/components/schemas/ContentStabilityExtensionValueCodeableConcept"

required:

- url

- valueCodeableConcept

ContentStabilityExtensionValueCodeableConcept:

allOf:

- $ref: "#/components/schemas/CodeableConcept"

- type: object

properties:

coding:

type: array

items:

$ref: "#/components/schemas/ContentStabilityExtensionCoding"

minItems: 1

maxItems: 1

required:

- coding

ContentStabilityExtensionCoding:

allOf:

- $ref: "#/components/schemas/Coding"

- type: object

properties:

system:

type: string

enum:

- "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability"

code:

type: string

enum: ["static", "dynamic"]

display:

type: string

enum: ["Static", "Dynamic"]

required:

- system