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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

File Consumer (client)

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

File Consumer (client) implementing Retrieve File

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

File Manager (server)

IHE ITI Non-patient File Sharing (NPFS) - File Manager (server)

File Source (client)

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

File Source (client) implementing Update DocumentReference

IHE ITI Non-patient File Sharing (NPFS) - File Source (client) - with ITI-89 Update DocumentReference

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Audit Event for Retrieve File Transaction at File Consumer

Defines constraints on the File Consumer AuditEvent Resource to record when a Retrieve File Transaction happens, as recorded by the File Consumer.

  • Build off of the IHE BasicAudit Read event
  • add the ITI-109 as a subtype
  • client is File Consumer
  • server is File Manager
  • entity slices for data
  • entity slice for transaction is available
Audit Event for Retrieve File Transaction at the File Manager

Defines constraints on the File Manager AuditEvent Resource to record when a Retrieve File Transaction happens, as recorded by the File Manager.

  • Build off of the IHE BasicAudit Read event
  • add the ITI-109 as a subtype
  • client is File Consumer
  • server is File Manager
  • entity slices for data
  • entity slice for transaction is available
Audit Event for Search File Transaction at File Manager

Defines constraints on the AuditEvent Resource to record when a Search File Transaction happens, as recorded by the File Manager.

  • Build off of the IHE BasicAudit Query event
  • add the ITI-88 as a subtype
  • client is File Consumer
  • server is File Manager
  • entity slices for query
  • entity slice for transaction is available
Audit Event for Search File Transaction by the File Consumer

Defines constraints on the AuditEvent Resource to record when a Search File Transaction happens, as recorded by the File Consumer.

  • Build off of the IHE BasicAudit Query event
  • add the ITI-88 as a subtype
  • client is File Consumer
  • server is File Manager
  • entity slices for query
  • entity slice for transaction is available
Audit Event for Submit File Transaction at Manager

Defines constraints on the AuditEvent Resource to record when a Submit File Transaction happens at the Manager.

  • Import event
  • shall have source of itself
  • shall have a File Source agent
  • shall have a File Manager agent
  • may have user, app, organization agent(s)
  • shall have a DocumentReference identity entity
Audit Event for Submit File Transaction at Source

Defines constraints on the AuditEvent Resource to record when a Submit File Transaction happens at the Source.

  • Export event
  • shall have source of itself
  • shall have a File Source agent
  • shall have a File Manager agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a submission set identity entity
Audit Event for Update DocumentReference Transaction at File Source

Defines constraints on the File Source AuditEvent Resource to record when an Update DocumentReference Transaction happens, as recorded by the File Source.

  • Build off of the IHE BasicAudit Update event
  • add the ITI-89 as a subtype
  • client is File Source
  • server is File Manager
  • entity slices for the DocumentReference reference
  • entity slice for transaction is available
Audit Event for Update DocumentReference Transaction at the File Manager

Defines constraints on the File Manager AuditEvent Resource to record when a Update DocumentReference Transaction happens, as recorded by the File Manager.

  • Build off of the IHE BasicAudit PatientRead event
  • add the ITI-89 as a subtype
  • client is File Source
  • server is File Manager
  • entity slices for DocumentReference reference
  • entity slice for transaction is available
NPFS Create Document Bundle

A profile on the Bundle transaction for ITI-87 Submit File used to submit a new file and related metadata

  • shall be a Transaction Bundle
  • all resources shall be compliant with constraints
  • may create one DocumentReference
NPFS DocumentReference

A profile on the DocumentReference resource for NPFS.

NPFS Replace Document Bundle

A profile on the Bundle transaction for ITI-87 Submit File used to replace a file and related metadata

  • shall be a Transaction Bundle
  • all resources shall be compliant with constraints
  • may replace one DocumentReference
NPFS Update Document Bundle

A profile on the Bundle transaction for ITI-87 Submit File used to update a file and related metadata

  • shall be a Transaction Bundle
  • all resources shall be compliant with constraints
  • may update one DocumentReference

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

NPFS DocumentReference category

ValueSet for the different values of element category

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

NPFS classcode

IHE Category (Class) Code set for use with Non-Patient File Sharing

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Create Document Bundle

Example of Bundle transaction for ITI-87 Submit File used to submit a new file and related metadata

DocumentReference for Minimal metadata

Example of a minimal DocumentReference resource. This is very unlikely to be acceptable anywhere, but it is the minimum required.

DocumentReference for Update

Example of a DocumentReference resource for Update. This is fully filled for all mandatory elements and all optional elements.

Dummy Patient example

Dummy patient example for completeness sake. No actual use of this resource other than an example target

Dummy Practitioner example

Dummy Practitioner example for completeness sake. No actual use of this resource other than an example target

Replace Document Bundle

Example of Bundle transaction for ITI-87 Submit File used to Replace a file and related metadata

Update Document Bundle

Example of Bundle transaction for ITI-87 Submit File used to update a file and related metadata