This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is the narrative for the resource. See also the XML, JSON or Turtle format.
OPERATION: Convert from one form to another
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 | Cardinality | Type | Binding | Documentation |
IN | input | 1..1 | Resource | The resource that is to be converted | |
OUT | output | 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:
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:
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.