Conceptmap-operation-closure

Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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

4.10.16.2 Operation $closure on ConceptMap

Vocabulary

Work Group

Maturity Level: 3

Trial Use

Compartments: N/A

This operation provides support for ongoing maintenance of a client-side transitive closure table based on server-side terminological logic. For details of how this is used, see Maintaining a Closure Table.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/ConceptMap-closure

Formal Definition (as a OperationDefinition).

URL: [base]/$closure

This is not an idempotent operation

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

name

1..1

string

The name that defines the particular context for the subsumption based closure table

concept

0..*

Coding

Concepts to add to the closure table

version

0..1

string

A request to resynchronise - request to send all new entries since the nominated version was sent by the server

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

return

1..1

ConceptMap

A list of new entries (code / system --> code/system) that the client should add to its closure table. The only kind of entry mapping equivalences that can be returned are equal, specializes, subsumes and unmatched

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

4.10.16.2.1 Examples

Request:

POST [base]/$closure

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
      "name" : "name",
      "valueString" : "patient-problems"
    },
    {
      "name" : "concept",
      "valueCoding" : {
        "system" : "http://snomed.info/sct",
        "code" : "22298006",
      }
    }
  ]
}

Response:

HTTP/1.1 200 OK
[other headers]

{
  "resourceType": "ConceptMap",
  "identifier": "49088976-d54d-4d19-b868-3d4c18cebabb",
  "version": "8",
  "status": "active",
  "experimental": true,
  "date": "2012-06-13",
  "group": [
    {
      "source": "http://snomed.info/sct",
      "target": "http://snomed.info/sct",
			"element" : {
				"code": "22298006",
				"target": [
					{
						"code": "128599005",
						"equivalence": "subsumes"
					}
				]
			}
    },
  ]
}

For more information about operations, including how they are invoked, see Operations.