ValueSet

See FHIR specification

Semantical type

The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name ValueSet into your applications access filter if you need to use this resource.

Resource owner

The creator of the resource is always the owner of the resource.

Public or private resource

The resource will often be used as public resource without access restrictions. However it is possible to create non public instances and share these with other entities.

It is important that you specify in the access filter of your applications if you want to use public resources, private resources or both.

Example 

{
  "resourceType": "ValueSet",
  "meta" : {
      "security": [ 
          {
              "system": "http://midata.coop/codesystems/security",
              "code": "public",
              "display": "Public"
          }
      ]          
  },
  "url": "http://hl7.org/fhir/ValueSet/yesnodontknow",
  "version": "4.0.1",
  "name": "Yes/No/Don't Know",
  "status": "draft",
  "description": "For Capturing simple yes-no-don't know answers",
  "compose": {
    "include": [
      {
        "valueSet": [
          "http://terminology.hl7.org/ValueSet/v2-0136"
        ]
      },
      {
        "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
        "concept": [
          {
            "code": "asked-unknown",
            "display": "Don't know"
          }
        ]
      }
    ]
  },
  "expansion": {
    "identifier": "urn:uuid:bf99fe50-2c2b-41ad-bd63-bee6919810b4",
    "timestamp": "2015-07-14T10:00:00Z",
    "contains": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0136",
        "code": "Y",
        "display": "Yes"
      },
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0136",
        "code": "N",
        "display": "No"
      },
      {
        "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
        "code": "asked-unknown",
        "display": "Don't know"
      }
    ]
  }
}

Read

Read a single ValueSet by id.

Request:

[GET] /fhir/ValueSet/<id>

Read specific version

Read a specific version of a single ValueSet by id.

Request:

[GET] /fhir/ValueSet/<id>/_history/<version>

Retrieve history

Retrieve all versions of a single resource.

Request:

[GET] /fhir/ValueSet/<id>/_history

Search for resources of type ValueSet

Request:

[GET] /fhir/ValueSet?searchParams

List of supported search parameters:

Supported query parameters:

Name Type Description
_id string The resource identity
_lastUpdated date Only return resources which were last updated as specified by the given range
_page string  
code token This special parameter searches for codes in the value set.
context token A use context assigned to the value set.
context-quantity quantity A quantity- or range-valued use context assigned to the value set
context-type token A type of use context assigned to the value set ValueSet.useContext.code
context-type-quantity composite A use context type and quantity- or range-based value assigned to the value set
context-type-value composite A use context type and value assigned to the value set
date date The value set publication date
description string The description of the value set
expansion uri Identifies the value set expansion (business identifier)
identifier token External identifier for the value set
jurisdiction token Intended jurisdiction for the value set
name string Computationally friendly name of the value set
publisher string Name of the publisher of the value set
reference uri A code system included or excluded in the value set or an imported value set
status token The current status of the value set
title string The human-friendly name of the value set
url uri The uri that identifies the value set
version uri The business version of the value set

Create

Create a new resource of type ValueSet. If you want to create a ValueSet resource that is visible to the public you must include a special security tag into the resource.

{
  "resourceType": "ValueSet",
  "meta" : {
      "security": [ 
          {
              "system": "http://midata.coop/codesystems/security",
              "code": "public",
              "display": "Public"
          }
      ]          
  },
  ...
}

Request:

[POST] /fhir/ValueSet

Update

Updates a resource of type ValueSet.

Request:

[PUT] /fhir/ValueSet/<id>

Operations

Neither $expand nor $validate-code are currently implemented.