ValueSet

Overview

The ValueSet resource official FHIR documentation can be found here: https://www.hl7.org/fhir/valueset.html.
All examples below can be executed in the REST Console of your Box in Aidbox.Cloud. Just copy/paste a sample into the REST Console and click the EXECUTE button or press Ctrl+Enter.
Also, you can run all examples in Postman having Aibox.Dev running locally, or by setting up a box in Aidbox.Cloud. Download the Aidbox collection and open it in Postman. Set up the proper environment value for the base variable which should be the base URL of your FHIR server. Setup authorization if you are using Aidbox.Cloud.
​​
​
​

CRUD

CRUD is fully supported for the ValueSet resource in Aidbox.
Create
Response
Update
Response
Read
Response
Delete
1
POST /ValueSet
2
content-type: text/yaml
3
​
4
description: The gender of a person used for administrative purposes. 2
5
compose:
6
include:
7
- system: http://hl7.org/fhir/administrative-gender
8
exclude:
9
- system: http://hl7.org/fhir/administrative-gender
10
concept:
11
- code: other
12
- code: unknown
13
name: AdministrativeGender2
14
experimental: true
15
resourceType: ValueSet
16
status: draft
17
id: administrative-gender2
18
url: http://hl7.org/fhir/ValueSet/administrative-gender2
19
immutable: true
Copied!
1
description: The gender of a person used for administrative purposes. 2
2
compose:
3
exclude:
4
- system: http://hl7.org/fhir/administrative-gender
5
concept:
6
- code: other
7
- code: unknown
8
include:
9
- system: http://hl7.org/fhir/administrative-gender
10
name: AdministrativeGender2
11
experimental: true
12
resourceType: ValueSet
13
status: draft
14
id: administrative-gender2
15
url: http://hl7.org/fhir/ValueSet/administrative-gender2
16
immutable: true
Copied!
1
PUT /ValueSet/administrative-gender2
2
​
3
description: The gender of a person used for administrative purposes. 2
4
compose:
5
include:
6
- system: http://hl7.org/fhir/administrative-gender
7
exclude:
8
- system: http://hl7.org/fhir/administrative-gender
9
concept:
10
- code: other
11
- code: unknown
12
name: AdministrativeGender2
13
experimental: true
14
resourceType: ValueSet
15
status: draft
16
id: administrative-gender2
17
url: http://hl7.org/fhir/ValueSet/administrative-gender2
18
immutable: true
19
version: 3.3.2
Copied!
1
description: The gender of a person used for administrative purposes. 2
2
compose:
3
exclude:
4
- system: http://hl7.org/fhir/administrative-gender
5
concept:
6
- code: other
7
- code: unknown
8
include:
9
- system: http://hl7.org/fhir/administrative-gender
10
name: AdministrativeGender2
11
experimental: true
12
resourceType: ValueSet
13
status: draft
14
id: administrative-gender2
15
url: http://hl7.org/fhir/ValueSet/administrative-gender2
16
immutable: true
17
version: 3.3.2
Copied!
1
GET /ValueSet/administrative-gender2
Copied!
1
description: The gender of a person used for administrative purposes. 2
2
compose:
3
exclude:
4
- system: http://hl7.org/fhir/administrative-gender
5
concept:
6
- code: other
7
- code: unknown
8
include:
9
- system: http://hl7.org/fhir/administrative-gender
10
name: AdministrativeGender2
11
experimental: true
12
resourceType: ValueSet
13
status: draft
14
id: administrative-gender2
15
url: http://hl7.org/fhir/ValueSet/administrative-gender2
16
immutable: true
17
version: 3.3.2
Copied!
1
DELETE /ValueSet/administrative-gender2
Copied!

ValueSet Compose Parameters

We will show examples of using the compose element by expanding different value sets.

include.concept

Create a ValueSet using the include.concept element. The result will include only listed concepts: kg and m.
Request
Response
1
POST /ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: sample-valueset-include-concept
10
status: draft
11
compose:
12
include:
13
- system: http://unitsofmeasure.org
14
concept:
15
- code: kg
16
display: kilogram
17
- code: m
18
display: meter
Copied!
1
resourceType: ValueSet
2
id: sample-valueset-include-concept
3
status: draft
4
compose:
5
include:
6
- system: http://unitsofmeasure.org
7
concept:
8
- code: kg
9
display: kilogram
10
- code: m
11
display: meter
12
expansion:
13
timestamp: '2018-10-25T14:40:09Z'
14
identifier:
15
contains:
16
- code: kg
17
system: http://unitsofmeasure.org
18
display: kilogram
19
- code: m
20
system: http://unitsofmeasure.org
21
display: meter
Copied!

include.filter

Create a ValueSet using the include.filter element.
Include all concepts from the http://hl7.org/fhir/contact-point-system system where display = "SMS".
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: sample-valueset-include-filter
10
url: http://hl7.org/fhir/ValueSet/sample-valueset-include-filter
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/contact-point-system
15
filter:
16
- {property: display, op: =, value: SMS}
Copied!
1
expansion:
2
timestamp: '2018-10-05T11:56:22Z'
3
identifier: http://hl7.org/fhir/ValueSet/sample-valueset-include-filter
4
contains:
5
- {code: sms, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: SMS, definition: 'A contact that can be used for sending an sms message (e.g. mobile phones, some landlines)'}
6
...
Copied!

exclude.concept

Create a ValueSet using the exclude.concept element.
Include all concepts from the http://hl7.org/fhir/contact-point-system system and exclude concepts pager, url, and other. Now the value set should include only values phone, fax, email, and sms.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: sample-valueset-exclude-concept
10
url: http://hl7.org/fhir/ValueSet/sample-valueset-exclude-concept
11
status: draft
12
compose:
13
include:
14
- {system: 'http://hl7.org/fhir/contact-point-system'}
15
exclude:
16
- concept:
17
- {code: pager}
18
- {code: other}
19
- {code: url}
20
system: http://hl7.org/fhir/contact-point-system
Copied!
1
expansion:
2
timestamp: '2018-10-05T12:13:23Z'
3
identifier: http://hl7.org/fhir/ValueSet/sample-valueset-exclude-concept
4
contains:
5
- {code: phone, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Phone, definition: The value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.}
6
- {code: fax, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Fax, definition: The value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.}
7
- {code: email, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Email, definition: The value is an email address.}
8
- {code: sms, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: SMS, definition: 'A contact that can be used for sending an sms message (e.g. mobile phones, some landlines)'}
9
...
10
Copied!

exclude.filter

Create a ValueSet using the exclude.filter element.
Include all concepts from the http://hl7.org/fhir/contact-point-system code system and exclude concepts by the filter: exclude all concepts with the length of code = 3 (sms, fax, url). So the value set should include only values: phone, email, pager, and other.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: sample-valueset-exclude-filter
10
url: http://hl7.org/fhir/ValueSet/sample-valueset-exclude-filter
11
status: draft
12
compose:
13
include:
14
- {system: 'http://hl7.org/fhir/contact-point-system'}
15
exclude:
16
- system: http://hl7.org/fhir/contact-point-system
17
filter:
18
- {property: code, op: =, value: '\w{3}'}
Copied!
1
expansion:
2
timestamp: '2018-10-05T14:59:15Z'
3
identifier: http://hl7.org/fhir/ValueSet/sample-valueset-exclude-filter
4
contains:
5
- {code: phone, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Phone, definition: The value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required.}
6
- {code: email, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Email, definition: The value is an email address.}
7
- {code: pager, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Pager, definition: The value is a pager number. These may be local pager numbers that are only usable on a particular pager system.}
8
- {code: other, module: fhir-3.3.0, system: 'http://hl7.org/fhir/contact-point-system', display: Other, definition: 'A contact that is not a phone, fax, page or email address and is not expressible as a URL. E.g. Internal mail address. This SHOULD NOT be used for contacts that are expressible as a URL (e.g. Skype, Twitter, Facebook, etc.) Extensions may be used to distinguish "other" contact types.'}
9
...
Copied!

include.valueSet

Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.
concept and filter don't apply to valueSet.
N/B: ValueSet.compose.include.valueSet **** should be an array not a string.
Let's include the administrative-gender value set. There will be 4 concepts: male, female, unknown, and other.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-from-valueset
10
url: http://hl7.org/fhir/ValueSet/valueset-from-valueset
11
status: draft
12
compose:
13
include:
14
- valueSet: ['http://hl7.org/fhir/ValueSet/administrative-gender']
Copied!
1
expansion:
2
timestamp: '2018-10-09T11:34:26Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-from-valueset
4
contains:
5
- {code: male, module: fhir-3.3.0, system: 'http://hl7.org/fhir/administrative-gender', display: Male, definition: Male}
6
- {code: female, module: fhir-3.3.0, system: 'http://hl7.org/fhir/administrative-gender', display: Female, definition: Female}
7
- {code: other, module: fhir-3.3.0, system: 'http://hl7.org/fhir/administrative-gender', display: Other, definition: Other}
8
- {code: unknown, module: fhir-3.3.0, system: 'http://hl7.org/fhir/administrative-gender', display: Unknown, definition: Unknown}
9
...
Copied!

exclude.valueSet

Let's exclude administrative-gender2 which consists of male and female from administrative-gender code system. The result will be 2 values: other and unknown.
Request
Untitled
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-exclude-valueset
10
url: http://hl7.org/fhir/ValueSet/valueset-exclude-valueset
11
status: draft
12
compose:
13
include:
14
- {system: 'http://hl7.org/fhir/administrative-gender'}
15
exclude:
16
- valueSet: ['{{base}}/ValueSet/administrative-gender2']
Copied!
1
expansion:
2
timestamp: '2018-10-09T13:20:38Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-exclude-valueset
4
contains:
5
- {code: other, module: fhir-3.3.0, system: 'http://hl7.org/fhir/administrative-gender', display: Other, definition: Other}
6
- {code: unknown, module: fhir-3.3.0, system: 'http://hl7.org/fhir/administrative-gender', display: Unknown, definition: Unknown}
7
...
Copied!

Filter Operations

The filter.op element defines the kind of operation to perform as a part of the filter criteria. It can take one of the following values:
Code
Display
Support
=
Equals
Supported
is-a
Is A (by subsumption)
Supported
descendent-of
Descendent Of (by subsumption)
Supported
is-not-a
Not (Is A) (by subsumption)
Supported
regex
Regular Expression
Supported
in
In Set
Supported
not-in
Not in Set
Supported
generalizes
Generalizes (by Subsumption)
Not supported
exists
Exists
Supported
In the examples below we will use the goal-status code system which consists of :
Code
Parent codes
accepted
-
achieved
["accepted"]
ahead-of-target
["accepted", "in-progress"]
behind-target
["accepted", "in-progress"]
cancelled
-
entered-in-error
-
in-progress
["accepted"]
on-hold
["accepted"]
on-target
["accepted", "in-progress"]
planned
["accepted"]
proposed
-
rejected
-
sustaining
["accepted", "in-progress"]

Equals

Let's include only concepts with the specified property code equals the provided value cancelled. The result will include only one concept: cancelled.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-equals
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-equals
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: =, value: cancelled}
Copied!
1
expansion:
2
timestamp: '2018-10-08T12:26:56Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-equals
4
contains:
5
- {code: cancelled, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Cancelled, definition: The previously accepted goal is no longer being sought}
6
...
Copied!

Is A (by subsumption)

Let's include all concepts that have a transitive is-a relationship with the concept code in-progress provided as the value including the provided concept itself (i.e. include self and child codes). The result will include 5 values: in-progress, on-target, ahead-of-target, behind-target, and sustaining.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-is-a
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-is-a
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: is-a, value: in-progress}
Copied!
1
expansion:
2
timestamp: '2018-10-08T12:56:36Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-is-a
4
contains:
5
- code: in-progress
6
module: fhir-3.3.0
7
system: http://hl7.org/fhir/goal-status
8
display: In Progress
9
hierarchy: [accepted]
10
definition: The goal is being sought but has not yet been reached. (Also applies if goal was reached in the past but there has been regression and goal is being sought again)
11
- code: on-target
12
module: fhir-3.3.0
13
system: http://hl7.org/fhir/goal-status
14
display: On Target
15
hierarchy: [accepted, in-progress]
16
definition: The goal is on schedule for the planned timelines
17
- code: ahead-of-target
18
module: fhir-3.3.0
19
system: http://hl7.org/fhir/goal-status
20
display: Ahead of Target
21
hierarchy: [accepted, in-progress]
22
definition: The goal is ahead of the planned timelines
23
- code: behind-target
24
module: fhir-3.3.0
25
system: http://hl7.org/fhir/goal-status
26
display: Behind Target
27
hierarchy: [accepted, in-progress]
28
definition: The goal is behind the planned timelines
29
- code: sustaining
30
module: fhir-3.3.0
31
system: http://hl7.org/fhir/goal-status
32
display: Sustaining
33
hierarchy: [accepted, in-progress]
34
definition: The goal has been met, but ongoing activity is needed to sustain the goal objective
35
...
Copied!

Descendent Of (by subsumption)

Let's include all concepts that have a transitive is-a relationship with the concept code in-progress provided as the value excluding the provided concept itself (i.e. include child codes). The result will include 4 values: on-target, ahead-of-target, behind-target, and sustaining.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-descendent-of
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-descendent-of
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: descendent-of, value: in-progress}
Copied!
1
expansion:
2
timestamp: '2018-10-08T13:02:33Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-descendent-of
4
contains:
5
- code: on-target
6
module: fhir-3.3.0
7
system: http://hl7.org/fhir/goal-status
8
display: On Target
9
hierarchy: [accepted, in-progress]
10
definition: The goal is on schedule for the planned timelines
11
- code: ahead-of-target
12
module: fhir-3.3.0
13
system: http://hl7.org/fhir/goal-status
14
display: Ahead of Target
15
hierarchy: [accepted, in-progress]
16
definition: The goal is ahead of the planned timelines
17
- code: behind-target
18
module: fhir-3.3.0
19
system: http://hl7.org/fhir/goal-status
20
display: Behind Target
21
hierarchy: [accepted, in-progress]
22
definition: The goal is behind the planned timelines
23
- code: sustaining
24
module: fhir-3.3.0
25
system: http://hl7.org/fhir/goal-status
26
display: Sustaining
27
hierarchy: [accepted, in-progress]
28
definition: The goal has been met, but ongoing activity is needed to sustain the goal objective
29
...
Copied!

Not (Is A) (by subsumption)

Let's include all codes where the specified property of the code does not have an is-a relationship with the provided value accepted. The result will include 4 values whose parent is not accepted: proposed, cancelled, rejected, and entered-in-error.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-is-not-a
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-is-not-a
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: is-not-a, value: accepted}
Copied!
1
expansion:
2
timestamp: '2018-10-10T13:44:22Z'
3
identifier: http://localhost:8888/ValueSet/valueset-filter-is-not-a
4
contains:
5
- {code: proposed, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Proposed, definition: A goal is proposed for this patient}
6
- {code: cancelled, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Cancelled, definition: The previously accepted goal is no longer being sought}
7
- {code: entered-in-error, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Entered In Error, definition: The goal was entered in error and voided.}
8
- {code: rejected, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Rejected, definition: A proposed goal was rejected}
9
...
Copied!

Regular Expression

Aidbox supports filter operation regex and implements Postgresql regular expressions. See the documentation here: https://www.postgresql.org/docs/9.3/static/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP.
Please notice that regular expressions require an additional character escaping in JSON.
Let's include codes where the specified property of the code matches the regex specified in the provided value \\w{8}. The result will include 4 values that have 8 symbols in length: proposed, accepted, achieved, and rejected.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-equals
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-equals
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: regex, value: '\w{8}'}
Copied!
1
expansion:
2
timestamp: '2018-10-08T13:32:27Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-equals
4
contains:
5
- {code: proposed, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Proposed, definition: A goal is proposed for this patient}
6
- {code: accepted, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Accepted, definition: A proposed goal was accepted or acknowledged}
7
- code: achieved
8
module: fhir-3.3.0
9
system: http://hl7.org/fhir/goal-status
10
display: Achieved
11
hierarchy: [accepted]
12
definition: The goal has been met and no further action is needed
13
- {code: rejected, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Rejected, definition: A proposed goal was rejected}
14
...
Copied!

In Set

Let's include concepts where the specified property of the code is in the set of codes specified in the provided value on-target,ahead-of-target,behind-target (comma separated list). The result will be 3 values: on-target, ahead-of-target, and behind-target.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-in
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-in
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: in, value: 'on-target,ahead-of-target,behind-target'}
Copied!
1
expansion:
2
timestamp: '2018-10-08T13:49:22Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-in
4
contains:
5
- code: on-target
6
module: fhir-3.3.0
7
system: http://hl7.org/fhir/goal-status
8
display: On Target
9
hierarchy: [accepted, in-progress]
10
definition: The goal is on schedule for the planned timelines
11
- code: ahead-of-target
12
module: fhir-3.3.0
13
system: http://hl7.org/fhir/goal-status
14
display: Ahead of Target
15
hierarchy: [accepted, in-progress]
16
definition: The goal is ahead of the planned timelines
17
- code: behind-target
18
module: fhir-3.3.0
19
system: http://hl7.org/fhir/goal-status
20
display: Behind Target
21
hierarchy: [accepted, in-progress]
22
definition: The goal is behind the planned timelines
23
...
Copied!

Not in Set

Let's include concepts where the specified property of the code is not in the set of codes specified in the provided value accepted,achieved,ahead-of-target,behind-target,cancelled,entered-in-error,in-progress,on-hold,on-target,planned (comma separated list). The result will include 3 values: proposed, rejected, and sustaining.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-not-in
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-not-in
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: code, op: not-in, value: 'accepted,achieved,ahead-of-target,behind-target,cancelled,entered-in-error,in-progress,on-hold,on-target,planned'}
Copied!
1
expansion:
2
timestamp: '2018-10-08T14:10:21Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-not-in
4
contains:
5
- {code: proposed, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Proposed, definition: A goal is proposed for this patient}
6
- code: sustaining
7
module: fhir-3.3.0
8
system: http://hl7.org/fhir/goal-status
9
display: Sustaining
10
hierarchy: [accepted, in-progress]
11
definition: The goal has been met, but ongoing activity is needed to sustain the goal objective
12
- {code: rejected, module: fhir-3.3.0, system: 'http://hl7.org/fhir/goal-status', display: Rejected, definition: A proposed goal was rejected}
13
...
Copied!

Generalizes (by Subsumption)

This parameter is not supported in Aidbox.

Exists

The specified property of the code has at least one value (if the specified value is true; if the specified value is false, then matches when the specified property of the code has no values).
Let's display concepts where property hierarchy exists. The result will include 8 concepts for which hierarchy is not an empty array: achieved, ahead-of-target, behind-target, in-progress, on-hold, on-target, planned, and sustaining.
Request
Response
1
POST {{base}}/ValueSet/$expand
2
content-type: text/yaml
3
​
4
resourceType: Parameters
5
parameter:
6
- name: valueSet
7
resource:
8
resourceType: ValueSet
9
id: valueset-filter-exists
10
url: http://hl7.org/fhir/ValueSet/valueset-filter-exists
11
status: draft
12
compose:
13
include:
14
- system: http://hl7.org/fhir/goal-status
15
filter:
16
- {property: hierarchy, op: exists, value: true}
Copied!
1
expansion:
2
timestamp: '2018-10-08T15:14:18Z'
3
identifier: http://hl7.org/fhir/ValueSet/valueset-filter-exists
4
contains:
5
- code: planned
6
module: fhir-3.3.0
7
system: http://hl7.org/fhir/goal-status
8
display: Planned
9
hierarchy: [accepted]
10
definition: A goal is planned for this patient
11
- code: in-progress
12
module: fhir-3.3.0
13
system: http://hl7.org/fhir/goal-status
14
display: In Progress
15
hierarchy: [accepted]
16
definition: The goal is being sought but has not yet been reached. (Also applies if goal was reached in the past but there has been regression and goal is being sought again)
17
- code: on-target
18
module: fhir-3.3.0
19
system: http://hl7.org/fhir/goal-status
20
display: On Target
21
hierarchy: [accepted, in-progress]
22
definition: The goal is on schedule for the planned timelines
23
- code: ahead-of-target
24
module: fhir-3.3.0
25
system: http://hl7.org/fhir/goal-status
26
display: Ahead of Target
27
hierarchy: [accepted, in-progress]
28
definition: The goal is ahead of the planned timelines
29
- code: behind-target
30
module: fhir-3.3.0
31
system: http://hl7.org/fhir/goal-status
32
display: Behind Target
33
hierarchy: [accepted, in-progress]
34
definition: The goal is behind the planned timelines
35
- code: sustaining
36
module: fhir-3.3.0
37
system: http://hl7.org/fhir/goal-status
38
display: Sustaining
39
hierarchy: [accepted, in-progress]
40
definition: The goal has been met, but ongoing activity is needed to sustain the goal objective
41
- code: achieved
42
module: fhir-3.3.0
43
system: http://hl7.org/fhir/goal-status
44
display: Achieved
45
hierarchy: [accepted]
46
definition: The goal has been met and no further action is needed
47
- code: on-hold
48
module: fhir-3.3.0
49
system: http://hl7.org/fhir/goal-status
50
display: On Hold
51
hierarchy: [accepted]
52
definition: The goal remains a long term objective but is no longer being actively pursued for a temporary period of time.
53
...
Copied!

Operations

FHIR specification
Status
Documentation and samples
​$expand​
supported
​ValueSet Expansion​
​$validate-code​
supported