resource $convert

Convert from one form to another

Description: This operation takes a resource in one form, and returns to in another form. Both the resource and return parameters are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)

Comments: 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 return parameter resource type may be different from the resource parameter resource type (for example, it might be a bundle)
• binary resources may be represented directly using some other content-type (in other words, just posting the content directly)

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

Affects State: false

System: true

Type: false

Instance: false

URL: http://hl7.org/fhir/build/OperationDefinition/Resource-convert

Parameters

• resource [in] 1..1 Resource — The resource that is to be converted
• return [out] 1..1 Resource — The resource after conversion