. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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 R3 R2
This is the narrative for the resource. See also the XML or JSON format.
OPERATION: Value Set based Validation
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
URL: [base]/ValueSet/$Value Set based Validation
URL: [base]/ValueSet/[id]/$Value Set based Validation
Parameters
| Use | Name | Cardinality | Type | Documentation |
| IN | identifier | 0..1 | uri | A logical value set identifier (i.e. ValueSet.identifier). The server must know the value set (e.g. it is defined explicitly in the server's valuesets, or it is defined implicitly by some code system known to the server |
| IN | valueSet | 0..1 | ValueSet | The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion |
| IN | code | 0..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 |
| IN | version | 0..1 | string | The version of the system, if one was provided in the source data |
| IN | display | 0..1 | string | The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return athe recommended display name in an extension in the outcome |
| IN | coding | 0..1 | Coding | A coding to validate |
| IN | codeableConcept | 0..1 | CodeableConcept | A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict with each other |
| IN | date | 0..1 | dateTime | The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point 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. |
| IN | abstract | 0..1 | boolean | if true, then an abstract code is allowed to be used in the context of the code that is being validated. Typically, abstract codes are allowed to be used in value set specifications (e.g. any code that is subsumed by an abstract code). If false (which is the default value), then only concrete codes as defined by the value set are allowed |
| OUT | result | 1..1 | boolean | True if the concept details supplied are valid |
| OUT | message | 0..1 | string | Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings |
| OUT | display | 0..1 | string | A valid display for the concept if the system wishes to display this to a user |
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:14+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change