Radiology (Sandbox)
0.0.1-current - ci-build International flag

Requirement Specification

This is for collaboration and discussion purposes and is subject to change.

This is not an Implementation Guide

Radiology (Sandbox) - Local Development build (v0.0.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Finding and Retrieving Document Entries NRL

Official URL: https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindDocumentsNRL Version: 0.0.1-current
Draft as of 2024-04-20 Computable Name: FindDocumentsNRL

This is a local version of

for documentation purposes.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement FindDocumentsNRL

Finding and Retrieving Document Entries NRL

  • Implementation Guide Version: 0.0.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-04-20
  • Published by: NHS England

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Security

See NRL API Documentation

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DocumentReferencehttps://fhir.nhs.uk/England/RAD/StructureDefinition/NRL-DocumentReference
Additional supported profiles:
  https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference		yysubject:identifier
Base System Profile
NRL DocumentReference
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference

Interaction summary
  • Supports read, search-type.

Documentation

Read

GET /DocumentReference/{id}

Example

GET /DocumentReference/5678

Example API response:

Search

GET /DocumentReference?{parameters}

Example

GET /DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888

Example response:

Implementers SHALL also conform to UKCore-DocumentReference and conformance to all profiles SHOULD be tested via FHIR Validation.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLsubject:identifiertoken

An Identifier for Who/what is the subject of the document