STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-codesystem-infer

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

Performing inferencing based on a set of codes - e.g. a mix of composition and decomposition

OPERATION: Performing inferencing based on a set of codes - e.g. a mix of composition and decomposition

Given a set of property/concept pairs, return a set of concepts for requested properties.

Typically, this operation is used to perform composition - given one or more properties, see if there is a common single code for all of them - or decomposition - given a code or expression, find out what it implies about the value of a specific property. It is defined a single operation, though, because it may be necessary to provide multiple inputs and outputs for both cases.

To use this operation, a client provides a set of property / concept pairs. One (or more) of the properties may be be labeled with the special property name $main which indicates that is a full code. In addition, the client provides one or more "request" parameter listing the properties it wishes returned, which may include $main. The server determines what of the request properties it is able to return, and returns a set of property/concept pairs as requested. In addition, the server can return a message with information about the inferencing it was able to perform. If the server cannot process the request at all, it should return an OperationOutcome with one or more errors.

URL: [base]/CodeSystem/$infer

URL: [base]/CodeSystem/[id]/$infer

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

system

0..1

uri

The system in which inferencing is to be performed. This must be provided unless the operation is invoked on a code system instance

IN

version

0..1

string

The version of the system for the inferencing to be performed

IN

concept

1..*

Concepts provided by the client on which inferencing is to be performed

IN

concept.property

1..1

code

The property that this concept represents, or $main if it doesn't represent a particular property

IN

concept.code

1..1

code

The code or expression for the property

IN

property

0..*

code

A property that is requested to be returned

OUT

message

0..1

string

Information from the server about the request. Note that if there is an error processing the request, an operation outcome will be returned instead. The message may be used when the operation is partially successful

OUT

output

0..*

Concepts returned by the server as a result of the inferencing operation

OUT

output.property

1..1

code

The property that this concept represents, or $main if it doesn't represent a particular property

OUT

output.code

1..1

code

The code or expression for the property

OUT

output.display

0..1

string

Display for the returned code, to save the client from performing a $lookup immediately (recommended)

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.