This page is part of the FHIR Clinical Documents (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Operations

FHIR Clinical Document Operations

FHIR Operations are a supplement to standard queries, and are used to fulfill a number of purposes, such as where the server needs to play an active role in formulating the content of the response, where the intended purpose is to cause side effects such as the creation of new resources, or where there are server-side expectations in response to a client request.

FHIR Clinical Document Operations:

• convert-to-transaction-bundle: Convert a FHIR Clinical Document into a FHIR transaction bundle.

FHIR Operations from CORE:

• StructureMap based Transform Operation

  Many clinical documents are represented as CDA and many legacy systems will likely continue to produce CDA. It will be useful for FHIR servers to offer a means of transforming CDA to FHIR Clinical Documents in order for the server to consume them. The StructureMap Transform Operation offers a standard endpoint for this operation. As part of the input FHIR StructureMaps can be provided.

  The following is a list of resources, including FHIR StructureMaps:

  • R5 StructureMap resource
  • The FHIR Mapping Language (FML) page (this is R5 which does have some advances on the R4 version)
  • The FHIR spec FML tutorial, written by Oliver Egger
  • Corresponding GitHub repo to use as a basis for experimentation
  • HL7 International confluence page on FML
  • The Swiss matchbox server (c/o Oliver Egger et al)
    • Home page
    • Public test server endpoint
  • HL7 Switzerland IG cda-fhir-maps:
    • GitHub repository
    • Example FHIR-to-CDA FML file
    • FHIR to CDA datatype mapping FML file
    • Example REST requests to matchbox server using the above FML file

• $document Core Operation

  The $document Core Operation provides a means for a client to request a FHIR Document based on a Composition. It is suggested that a server may wish to emulate this behavior but using an operation that delivers a FHIR Clinical Document conformant to the profile in this guide (and possibly guidance from a use case specific IG). The specific Operation should be named appropriately.

FHIR Operation experimental examples:

• $summary from the International Patient Summary (IPS) IG

The Operation provides a means to invoke the creation of a specific FHIR Clinical Document conformant to the IPS IG. Note: the current link is from build - this will be updated post-ballot.