https://tx.ontoserver.csiro.au/fhir/OperationDefinition/CodeSystem-it-find-matches
Operation
Given a set of code-value properties, return one or more possible matching codes.
OPERATION find-matches
This is an immature part of the FHIR Specification, and only initial support is provided, and both the exact
and compositional
parameters will have no impact on the output. The implementation effectively behaves aligned with exact=true
and compositional=false
, and as such is aimed at machine/automated use rather than human/interactive use.
URL: [base]/CodeSystem/$find-matches
URL: [base]/CodeSystem/[id]/$find-matches
May be invoked by performing an HTTP GET operation as well as a POST.
Parameters
Use | Name | Cardinality | Type | Binding | Documentation |
---|---|---|---|---|---|
IN | exact | 1..1 | boolean | Whether exact matches are required. | |
IN | compositional | 0..1 | boolean | Whether post-coordinated expressions are allowed as matches. | |
IN | property | 0..* | ParametersParameterComponent | `property.code` and `property.value` pairs; `property.subproperty` is not yet supported. | |
IN | system | 1..1 | uri | The code system in which to search for matches. | |
IN | version | 0..1 | string | Optional code system version. |
{ "resourceType": "OperationDefinition", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Operation</div>" }, "url": "https://tx.ontoserver.csiro.au/fhir/OperationDefinition/CodeSystem-it-find-matches", "name": "Find-matches", "title": "Given a set of code-value properties, return one or more possible matching codes.", "status": "active", "kind": "operation", "description": "This is an immature part of the [FHIR Specification](https://hl7.org/fhir/R4/codesystem-operation-find-matches.html), and only initial support is provided, and both the `exact` and `compositional` parameters will have no impact on the output. The implementation effectively behaves aligned with `exact=true` and `compositional=false`, and as such is aimed at machine/automated use rather than human/interactive use.", "affectsState": false, "code": "find-matches", "resource": [ "CodeSystem" ], "system": false, "type": true, "instance": true, "parameter": [ { "extension": [ { "url": "http://hapifhir.io/fhir/StructureDefinition/op-parameter-example-value", "valueString": "true" } ], "name": "exact", "use": "in", "min": 1, "max": "1", "documentation": "Whether exact matches are required.", "type": "boolean" }, { "extension": [ { "url": "http://hapifhir.io/fhir/StructureDefinition/op-parameter-example-value", "valueString": "false" } ], "name": "compositional", "use": "in", "min": 0, "max": "1", "documentation": "Whether post-coordinated expressions are allowed as matches.", "type": "boolean" }, { "name": "property", "use": "in", "min": 0, "max": "*", "documentation": "`property.code` and `property.value` pairs; `property.subproperty` is not yet supported.", "type": "ParametersParameterComponent" }, { "extension": [ { "url": "http://hapifhir.io/fhir/StructureDefinition/op-parameter-example-value", "valueString": "http://snomed.info/sct" }, { "url": "http://hapifhir.io/fhir/StructureDefinition/op-parameter-example-value", "valueString": "http://loinc.org" } ], "name": "system", "use": "in", "min": 1, "max": "1", "documentation": "The code system in which to search for matches.", "type": "uri" }, { "name": "version", "use": "in", "min": 0, "max": "1", "documentation": "Optional code system version.", "type": "string" } ] }