Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4

Operation-resource-convert

Example OperationDefinition/Resource-convert (Narrative)

Maturity Level : N/A
Responsible Owner: FHIR Infrastructure Work Group Standards Status : Informative Compartments : Not linked to any No defined compartments

This is the narrative for the resource. See also the XML , JSON or Turtle format.

Note that this is the formal definition for the convert operation as an OperationDefinition on Resource. See the Operation documentation

Convert from one form to another

OPERATION: Convert from one form to another Generated Narrative: OperationDefinition Resource-convert The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/Resource-convert This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)

URL: [base]/$convert

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN input resource 1..1 Resource

The resource that is to be converted

OUT output return 1..1 Resource

The resource after conversion

While the primary use of this operation is simple - converting a resource from one format to another, there are many potential uses including:

  • converting resources from one version to another
  • restructuring information in a resource (e.g. moving method into/out of Observation.code)
  • extracting data from a questionnaire
  • converting CDA documents or v2 messages (as a binary resource) to a bundle (or vice versa) (or even openEHR or openMHealth).

These variants would all be associated with parameters that define and control these kind of conversions, though such parameters are not defined at this time. In the absence of any parameters, simple format conversion is all that will occur.

For this reason, implementers should be aware that:

  • the output return resource type may be different from the input resource (particularly, parameter resource type (for example, it might be a bundle)
  • binary resources may be represented directly using some other content-type (i.e. (in other words, just post the content directly)

Implementers are encouraged to provide feedback to HL7 about their use of this operation

 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.