This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Terminology Infrastructure Work Group | Maturity Level: 1 | 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 canonical 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 | Scope | 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 | Scope | 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 relationships that can be returned are equivalent, source-is-broader-than-target and source-is-narrower-than-target. 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 |
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", "relationship": "source-is-narrower-than-target" } ] } }, ] }
For more information about operations, including how they are invoked, see Operations.