CodeSystem - FHIR v1.6.0

The code that is to be validated. If a code is provided, a system must be provided

system

0..1

uri

The system for the code that is to be validated

version

0..1

The version of the system, if one was provided in the source data

coding

0..1

A coding to look up

date

0..1

dateTime

The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.

property

0..*

A property that the client wishes to be returned in the output. If no properties are specified, the server chooses what to return. The following properties are defined for all code systems: system, version, display, definition, designation, parent, child, and lang.X where X is a language code in a designation. These properties refer to the directly return parameters documented for the operation

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

name

1..1

A display name for the code system

version

0..1

The version that these details are based on

display

1..1

The preferred display for this concept

property

0..*

property.code

0..1

property.value

1..1

property.description

0..1

Human Readable representation of the propery value

designation

0..*

Additional representations for this concept

designation.language

0..1

The language this designation is defined for

designation.use

0..1

A code that details how this designation would be used

designation.value

1..1

The text value for this designation

Note that the $lookup operation is more than just a code system search - the server finds the concept, and gathers the return information from the value set and the underlying code system definitions.

4.11.14.1.1 Examples

Looking up a code/system (Request):

GET [base]/CodeSystem/$lookup?system=http://loinc.org&code=1963-8

Lookup using a Coding (Request):

POST [base]/CodeSystem/$lookup
[other headers]

<Parameters xmlns="http://hl7.org/fhir">
  <parameter>
    <name value="coding"/>
  <valueCoding>
    <system value="http://loinc.org"/>
    <code value="1963-8"/>
  </valueCoding>
  </parameter>
</Parameters>

Response:

HTTP/1.1 200 OK
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "name",
    "valueString" : "LOINC"
  },
  {
    "name" : "version",
    "valueString" : "2.48"
  },
  {
    "name" : "designation",
    "valueString" : "Bicarbonate [Moles/volume] in Serum"
  },
  {
    "name" : "abstract",
    "valueString" : "false"
  },
  {
      "name" : "designation",
    "part" : [
    {
      "name" : "value",
      "valueString" : "Bicarbonate [Moles/volume] in Serum "
    }
    ]
  }
  ]
}

4.11.14.2 Subsumption Testing

Test whether code "sub" is subsumed by code "super" given the semantics of subsumption in the underlying code system

Formal Definition (as a OperationDefinition).

URL: [base]/CodeSystem/$subsumes

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

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

codeA

0..1

The "sub" code that is to be tested. If a code is provided, a system must be provided

codeB

0..1

The "super" code that is to be validated. If a code is provided, a system must be provided

system

0..1

uri

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

version

0..1

The version of the system, if one was provided in the source data

codingA

0..1

The "sub" coding to test. If the coding system does not have to match the specified subsumption system, but the relationships between the systems must be well established

codingB

0..1

The "super" coding to test. If the coding system does not have to match the specified subsumption system, but the relationships between the systems must be well established

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

outcome

1..1

Whether "sub" is subsumed by "super". There are 4 possible codes to be returned: equivalent, subsumes, subsumed-by, and not-subsumed. If the server is unable to determine the relationship between the codes, then it returns an error (i.e. an OperationOutcome)

4.11.14.2.1 Examples

Using simple parameters: is viral hepatitis a disorder of the liver? (Request):

GET [base]/CodeSystem/$subsumes?system=http://snomed.info/sct&codeA=3738000&codeB=235856003

Using Codings (Request):

POST [base]/CodeSystem/$subsumes
[other headers]

<Parameters xmlns="http://hl7.org/fhir">
  <!-- Subsumption testing - use SNOMED CT rules -->
  <parameter>
    <name value="system"/>
    <valuUri value="http://snomed.info/sct"/>
  </parameter>
  <!-- Australian distribution -->
  <parameter>
    <name value="version"/>
    <valuString value="http://snomed.info/sct/32506021000036107/version/20160430"/>
  </parameter>
  <parameter>
    <name value="codingA"/>
    <valueCoding>
      <system value="http://snomed.info/sct"/>
      <code value="3738000"/>
    </valueCoding>
  </parameter>
  <parameter>
    <name value="codingB"/>
    <valueCoding>
      <system value="http://snomed.info/sct"/>
      <code value="235856003"/>
    </valueCoding>
  </parameter>
</Parameters>

Response:

HTTP/1.1 200 OK
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "outcome",
    "valueCode" : "subsumes"
  }
}

4.11.14.3 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.

Formal Definition (as a OperationDefinition).

URL: [base]/CodeSystem/$infer

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

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

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

version

0..1

The version of the system for the inferencing to be performed

concept

1..*

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

concept.property

1..1

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

concept.code

1..1

The code or expression for the property

property

0..*

A property that is requested to be returned

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

message

0..1

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

output

0..*

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

output.property

1..1

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

output.code

1..1

The code or expression for the property

output.display

0..1