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 IHE ITI-67

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

Finding and Retrieving Document Entries

This is IHE Mobile access to Health Documents (MHD) - Find Document References ITI-67 linked to UK/NHS England specific Document Metadata

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement FindDocumentsMHD

Finding and Retrieving Document Entries

  • 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
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/DocumentEntry
Additional supported profiles:
  https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference		yy_id, _lastupdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type
Base System Profile
Document Entry
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/1234

Example API response:

Search

GET /DocumentReference?{parameters}

Example

GET /DocumentReference?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888&category=http://snomed.info/sct|721981007,http://snomed.info/sct|4201000179104

Example response:

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALL_lastupdateddate

When the resource version last changed

SHALLauthor.givenstring
SHALLauthor.familystring
SHALLcategorytoken

Categorization of document

SHALLcreationdate

When this document was created

SHALLdatedate

When this document reference was created

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLidentifiertoken

The identifier for this DocumentReference

SHALLpatientreference

Who/what is the subject of the document

SHALLpatient.identifierreference

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

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related Resource

SHALLsecurity-labeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created - e.g. clinical specialty

SHALLstatustoken

current | superseded | entered-in-error

SHALLtypetoken

Kind of document