Non-patient File Sharing (NPFS)
2.2.0 - Trial-Implementation International flag

This page is part of the Non-patient File Sharing (NPFS) (v2.2.0: Publication) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: File Consumer (client) implementing Retrieve File

Official URL: https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileConsumerOption Version: 2.2.0
Active as of 2022-10-27 Computable Name: IHE_NPFS_FileConsumerOption

IHE ITI Non-patient File Sharing (NPFS) - File Consumer (client) - with ITI-109 Retrieve File

Query Actors InteractionsFile ConsumerFile ManagerSearch File [ITI-88]↓Retrieve File [ITI-109]↓


Figure: Query Actors Interactions

Raw OpenAPI-Swagger Definition file | Download

File Consumer (client) implementing Retrieve Document

  • Implementation Guide Version: 2.2.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: Thu Oct 27 00:00:00 CDT 2022
  • Published by: IHE IT Infrastructure Technical Committee

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: client

CapabilityStatement for File Consumer implementing Retrieve Document

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions
  • Supports the search-system interaction.

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://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReferenceyy_id, identifier, patient, date, author.identifier, format, language, location, status, relatesto, relation, relationship
Binary y

Resource Conformance: supportedDocumentReference

Base System Profile
https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

Logical identifier of this artifact

SHALLpatienttoken

This parameter shall always be used in this transaction to find resources that do not have the patient element valued, e.g., patient:missing=true

SHALLdatedate

when the file, to which the DocumentReference refers, was submitted

SHALLauthor.identifiertoken

The author that has submitted the file

SHALLformattoken

File's format

SHALLlanguagetoken

The language of the file

SHALLlocationuri

Where the file can be found

SHALLstatustoken

The status of the file

SHALLrelatestoreference

One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource

SHALLrelationtoken

The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter

SHALLrelationshipcomposite

The combination of the relatesTo and relation search parameter.

 

Resource Conformance: supportedBinary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports read.