Non-patient File Sharing (NPFS)
2.2.1-current - ci-build International flag

Non-patient File Sharing (NPFS), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 2.2.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.NPFS/ and changes regularly. See the Directory of published versions

CapabilityStatement: File Consumer (client)

Official URL: https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileConsumer Version: 2.2.1-current
Active as of 2022-10-27 Computable Name: IHE_NPFS_FileConsumer

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

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


Figure: Query Actors Interactions

Raw OpenAPI-Swagger Definition file | Download

File Consumer (client)

  • Implementation Guide Version: 2.2.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2022-10-27
  • 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

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:exists, date, author.identifier, format, language, location, status, relatesto, relation, relationship

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

SHALLpatient:existstoken

This parameter shall always be used in this transaction to find resources that do not have the patient element valued

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.