FHIR^®🔥 API

Validate

The validate operation checks a resource's well-formedness against its schema, constraint rules, and against one or more profiles.

The operation can be invoked by sending a GET or POST request to:

http://ontoserver.base.url/fhir/[ResourceType]/[id]/$validate (instance level)

http://ontoserver.base.url/fhir/[ResourceType]/$validate (type level)

Where [ResourceType] is one of Ontoserver's supported Resource Types (ValueSet, CodeSystem, ConceptMap) or, if ontoserver.feature.generic-validation-enabled is set to true, type-level invocation for all FHIR Resource Types. Type-level requests can provide a resource to validate as a JSON/XML object in the body of a POST request.

If the profile parameter is provided, the resource will be validated against the most recent stored StructureDefinition with that URL. Otherwise, it will be validated against any profiles to which it claims to conform (in its meta section), or against the default profile for that resource type.

If a referenced StructureDefinition is not available locally, Ontoserver will look in the syndication feeds, if any, configured using atom.validation.feedLocation for the appropriate Resource. If found, the StructureDefinition will be fetched and used for the purposes of validation, but will not be automatically loaded into Ontoserver itself.

The operation returns a list of any issues with the resource, as well as their seriousness.

More information on the validate operation can be found in the FHIR specification.

Convert

The convert 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).

Ontoserver also supports converting FROM FHIR STU3 TO FHIR R4. This is done by specifying the FHIR version in the Content-type header. For example: Content-type: application/fhir+json; fhirVersion=3.0

The operation can be invoked by sending a POST request to:

http://ontoserver.base.url/fhir/$convert

More information on the convert operation can be found in the FHIR specification.

Diff

See here for details.

Batch

The batch operation allows for the invocation of a series of operations in a single call. Batch operations can be performed by sending a Bundle object, encoded as either JSON or XML (with an appropriate Content-Type header), of type batch, in a POST request to the FHIR base, i.e.

http://ontoserver.base.url/fhir

The operations supported in batch operations are: $expand, $lookup, $translate, $validate-code and $subsumes.

Each bundle entry in the batch request must specify a request method and url. GET entries may specify parameters in their URL; POST entries may specify parameters by providing a Parameters object in the resource parameter of the bundle entry.

Results from a batch request will be provided as a bundle object, with the results for individual requests in the same order as the request entries.

More information about the batch operation can be found in the FHIR Specification.

Versions

The result of this operation identifies the set of FHIR versions supported by Ontoserver along with the default FHIR version.

The operation can be invoked by sending a GET request to:

http://ontoserver.base.url/fhir/$versions

Meta

• $meta Returns a list of all profiles, tags, and security labels for the current version of the resource. Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource). More information can be found in the FHIR Specification

• $meta-add This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource. More information can be found in the FHIR Specification

• $meta-delete This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource. More information can be found in the FHIR Specification