Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Validate that a coded value is in the set of codes allowed by a value set. If the operation is not called at the instance level, one of the in parameters "identifier" or "valueset" must be provided. One (and only one) of the in parameters (code, coding, codeableConcept) must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code
GET [base]/ValueSet/$validate-code
GET [base]/ValueSet/[id]/$validate-code
Where:
| Use | Name | Cardinality | Type | Binding | Documentation |
|---|---|---|---|---|---|
| IN | code | 1..1 | code | The code that is to be validated. If a code is provided, a system must be provided. | |
| IN | system | 0..1 | uri | The system for the code that is to be validated | |
| OUT | result | 1..1 | boolean | True if the concept details supplied are valid | |
| OUT | display | 0..1 | string | A valid display for the concept if the system wishes to display this to a user |