ValueSet Code Validation

Overview

Value set code validation provides the ability to validate that a coded value is in the set of codes allowed by a value set. For more details, see the official documentation FHIR Terminology Value Set based Validation.

API

GET/POST URL: [base]/ValueSet/$validate-code

GET/POST URL: [base]/ValueSet/[id]/$validate-code

Example: for validation that female code allowed by a default AdministrativeGender ValueSet.

GET [base]/ValueSet/administrative-gender/$validate-code?code=female

Parameters

Parameter	Type	Status	Example
url	uri	`supported`	ValueSet Code Validation
context	uri	`not supported`
valueSet	ValueSet	`supported`	ValueSet Code Validation
code	code	`supported`	ValueSet Code Validation
system	uri	`supported`	ValueSet Code Validation
version	string	`supported`	ValueSet Code Validation
display	string	`supported`	ValueSet Code Validation
coding	Coding	`supported`	ValueSet Code Validation
codeableConcept	CodeableConcept	`supported`	ValueSet Code Validation
date	dateTime	`not supported`
abstract	boolean	`not supported`
displayLanguage	code	`not supported`

url code system version display

One of the concept property

yaml

GET [base]/ValueSet/$validate-code?url=http://hl7.org/fhir/ValueSet/administrative-gender&code=male&display=Male

yaml

POST [base]/ValueSet/$validate-code
content-type: text/yaml

resourceType: Parameters
parameter:
- {name: url, valueUri: 'http://hl7.org/fhir/ValueSet/administrative-gender'}
- {name: code, valueCode: male}
- {name: system, valueUri: 'http://hl7.org/fhir/administrative-gender'}
- {name: display, valueString: Male}

yaml

resourceType: Parameters
parameter:
- {name: result, valueBoolean: true}

valueSet

The value set is provided directly as a part of the request.

yaml

POST [base]/ValueSet/$validate-code
content-type: text/yaml

resourceType: Parameters
parameter:
- {name: code, valueCode: male}
- {name: system, valueUri: 'http://hl7.org/fhir/administrative-gender'}
- name: valueSet
  resource:
    resourceType: ValueSet
    url: http://custom/administrative-gender
    compose:
      include:
      - valueSet: ['http://hl7.org/fhir/ValueSet/administrative-gender']

yaml

resourceType: Parameters
parameter:
- {name: result, valueBoolean: true}

coding

A coding to validate

url parameter is required for $validate-code

yaml

POST [base]/ValueSet/$validate-code
content-type: text/yaml

resourceType: Parameters
parameter:
- name: coding
  valueCoding: {system: 'http://hl7.org/fhir/administrative-gender', code: male}
- {name: url, valueUri: 'http://hl7.org/fhir/ValueSet/administrative-gender'}

yaml

resourceType: Parameters
parameter:
- {name: result, valueBoolean: true}

codeableConcept

A full codeableConcept to validate.

yaml

POST [base]/ValueSet/$validate-code
content-type: text/yaml

resourceType: Parameters
parameter:
- name: codeableConcept
  valueCodeableConcept:
    coding:
    - {system: 'http://hl7.org/fhir/administrative-gender', code: male_wrong}
    - {system: 'http://hl7.org/fhir/administrative-gender', code: male}
- {name: url, valueUri: 'http://hl7.org/fhir/ValueSet/administrative-gender'}

yaml

resourceType: Parameters
parameter:
- {name: result, valueBoolean: true}