STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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-compose

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

Code Composition based on supplied properties

OPERATION: Code Composition based on supplied properties

Given a set of properties, return one or more possible matching codes

This operation takes a set of properties, and examines the code system looking for codes in the code system that match a set of known properties.

When looking for matches, there are 3 possible types of match: * a complete match - a code that represents all the provided properties correctly * a partial match - a code that represents some of the provided properties correctly, and not others * a possible match - a code that may represent the provided properties closely, but may capture less or more precise informationfor some of the properties

The $compose operation can be called in one of 2 modes: * By a human, looking for the best match for a set of properties. In this mode, the server returns a list of complete, possible or partial matches (possibly with comments), so that the user can choose (or not) the most appropriate code * By a machine (typically in a system interface performing a transformation). In this mode, the server returns only a list of complete and partial matches, but no possible matches. The machine can choose a code from the list (or not) based on what properties are not coded

The compose operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.

URL: [base]/CodeSystem/$compose

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

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

system

0..1

uri

The system in which composition 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

property

0..*

One or more properties that contain information to be composed into the code

IN

property.code

1..1

code

Identifies the property provided

IN

property.value

1..1

code

The value of the property provided

IN

property.subproperty

0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)

IN

property.subproperty.code

1..1

code

Identifies the sub-property provided

IN

property.subproperty.value

1..1

code

The value of the sub-property provided

IN

mode

1..1

code

Whether the operation is being used by a human, or a machine. If the operation is being used by a human, the terminology server can return a list of possible matches, with commentary. For a machine, the server returns sure matches, or none at all

IN

compositional

0..1

boolean

Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false

OUT

match

0..*

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

OUT

match.code

1..1

Coding

A code that matches the properties provided

OUT

match.unmatched

1..1

One or more properties that contain properties that could not be matched into the code

OUT

match.unmatched.code

1..1

code

Identifies the property provided

OUT

match.unmatched.value

1..1

code

The value of the property provided

OUT

match.unmatched.property

0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)

OUT

match.unmatched.property.code

1..1

code

Identifies the sub-property provided

OUT

match.unmatched.property.value

1..1

code

The value of the sub-property provided

OUT

match.comment

0..1

string

Information about the quality of the match, if operation is for a human

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.