Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to editions and direct aliases. #459

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@ All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 8.x.x Release (FUTURE RELEASE)

### Breaking
- ECL Dialect aliases have been updated to match the new agreed format, see [ECL spec Appendix C](https://confluence.ihtsdotools.org/display/DOCECL/Appendix+C+-+Dialect+Aliases).
(Affected aliases are en-int-gmdn, en-nhs-X, en-uk-X).

## 7.12.0 Release (November 2022)
Maintenance release with bug fixes and improvements.
### Improvements
- General
- MAINT-1974 Add optional configuration to allow new ReferenceSet types to be configured on branch other than MAIN.

### Fixes
- MAINT-2071 Remove communication with Authoring Acceptance Gateway when completing classifications.
- MAINT-1940 Stop inactive historical associations switching module when rebasing.
- FRI-565 Correct Extension's traceability log when performing rebase after upgrading dependency.


## 7.11.0 Release (October 2022)
Maintenance release with bug fixes and improvements.
### Improvements
Expand All @@ -23,6 +41,7 @@ Maintenance release with bug fixes and improvements.
- MAINT-1862 Fix `searchAfter` request parameter to work with ECL dot notation
- MAINT-2051 Fix the changing of a Concept's inactivation reason from resulting in duplicate ReferenceSetMembers


## 7.10.0 Release (September 2022)
Maintenance release with integration support for [Consul](https://www.consul.io/) and [Vault](https://www.vaultproject.io/)
### Features
Expand Down Expand Up @@ -50,7 +69,6 @@ Maintenance release with integration support for [Consul](https://www.consul.io/
- MAINT-2003 Correct default language refset configuration for `es`



## 7.9.3 Release (June 2022)
### Breaking
- ISTO-16 Add support for ECL 2.0. Snowstorm now requires all ECL queries to be valid according to ECL 2.0 specification.
Expand Down
221 changes: 123 additions & 98 deletions docs/fhir-resources/valueset-expansion.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,123 @@
## ValueSet Expansion

### Implicit ValueSets (ie intensionally defined).
See [https://www.hl7.org/fhir/snomedct.html#implicit]

## GET Method Request Example(s)

#### Expansion of an intentionally defined value set using ECL
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<27624003

#### Expansion of an intentionally defined value set using ECL against a specific edition/version
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<27624003&system-version=http://snomed.info/sct/900000000000207008/version/20190731

##### alternatively, the url parameter can also take a version URI. This is an equivalent request:
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct/900000000000207008/version/20190731?fhir_vs=ecl/<<27624003

#### Expansion of an intentionally defined value set using ECL against unpublished content (eg concepts newly created on the MAIN branch)
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/xsct?fhir_vs=ecl/<<27624003

#### Expansion of an intentionally defined value set using ISA
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=isa/27624003

#### Expansion including as-yet-unpublished changes to concepts
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=isa/410607006&system-version=http://snomed.info/xsct&count=5

#### Expansion of an intentionally defined value set using refset (ICD-10 complex map)
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=refset/447562003

#### Expansion of an intentionally defined value set using nothing! Returns all concepts.
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs

#### Expansion of an intentional value set against the Swedish Edition, including synonyms
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct/45991000052106?fhir_vs=ecl/%3C%3C27624003&includeDesignations=true&count=10&designation=sv&designation=en

#### Expansion of an intentional value set against the Swedish Edition, specifying Swedish Language for the display field (normally the server returns the FSN, which is in English in the Swedish Edition).
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct/45991000052106?fhir_vs=ecl/%3C%3C27624003&count=10&displayLanguage=sv

#### Expansion specifying a language reference set for the designation. However, since includeDesigntations is set to false, this results in a very minimal return with just the display returning as "Acetaminophen" due to being the US preferred term. Note that setting includeDesignations=true will return both preferred and acceptable terms
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/322280009&designation=http://snomed.info/sct|900000000000509007&includeDesignations=false

#### Paging through 10 at a time, request the 2nd page. Note that the offset is a number of elements, rather than a page offset, and must be a multiple of the page size ie count.
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<27624003&count=10&offset=10

#### Term filtering - ValueSet of all <<763158003 |Medicinal product (product)| containing the word aspirin. This is not case sensitive.
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<763158003&filter=Aspirin

#### Refset - list all SNOMED concepts mapped to ICD-O (ECL here is ^446608001 |ICD-O simple map reference set (foundation metadata concept)|)
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/%5E446608001&count=20

## POST Method Request Example(s)

#### Expansion with filter operation using ECL

```
curl --request POST 'http://localhost:8080/fhir/ValueSet/$expand' \
--header 'Content-Type: application/json' \
--data-raw '{
"resourceType": "Parameters",
"parameter": [
{
"name": "valueSet",
"resource": {
"resourceType": "ValueSet",
"compose": {
"include": [
{
"filter": [
{
"property": "concept",
"op": "is-a",
"value": "21351003"
}
]
}
]
}
}
},
{
"name": "system-version",
"valueString": "http://snomed.info/sct/900000000000207008/version/20200731"
},
{
"name": "displayLanguage",
"valueString": "en-GB"
},
{
"name": "offset",
"valueString": "1"
},
{
"name": "count",
"valueString": "5"
}
]
}'
```
Note that the curl --location flag will cause a POST body to be removed if a 302 redirect is encountered, such as happens when an http call is redirected to https.
## ValueSet Expansion

### Implicit ValueSets (ie intensionally defined).
See [https://www.hl7.org/fhir/snomedct.html#implicit]

## GET Method Request Example(s)

#### Expansion of an intentionally defined value set using ECL
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<27624003

#### Expansion of an intentionally defined value set using ECL against a specific edition/version
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<27624003&system-version=http://snomed.info/sct/900000000000207008/version/20190731

##### alternatively, the url parameter can also take a version URI. This is an equivalent request:
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct/900000000000207008/version/20190731?fhir_vs=ecl/<<27624003

#### Expansion of an intentionally defined value set using ECL against unpublished content (eg concepts newly created on the MAIN branch)
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/xsct?fhir_vs=ecl/<<27624003

#### Expansion of an intentionally defined value set using ISA
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=isa/27624003

#### Expansion including as-yet-unpublished changes to concepts
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=isa/410607006&system-version=http://snomed.info/xsct&count=5

#### Expansion of an intentionally defined value set using refset (ICD-10 complex map)
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=refset/447562003

#### Expansion of an intentionally defined value set using nothing! Returns all concepts.
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs

#### Expansion of an intentional value set against the Swedish Edition, including synonyms
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct/45991000052106?fhir_vs=ecl/%3C%3C27624003&includeDesignations=true&count=10&designation=sv&designation=en

#### Expansion of an intentional value set against the Swedish Edition, specifying Swedish Language for the display field (normally the server returns the FSN, which is in English in the Swedish Edition).
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct/45991000052106?fhir_vs=ecl/%3C%3C27624003&count=10&displayLanguage=sv

#### Expansion specifying a language reference set for the designation. However, since includeDesigntations is set to false, this results in a very minimal return with just the display returning as "Acetaminophen" due to being the US preferred term. Note that setting includeDesignations=true will return both preferred and acceptable terms
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/322280009&designation=http://snomed.info/sct|900000000000509007&includeDesignations=false

#### Paging through 10 at a time, request the 2nd page. Note that the offset is a number of elements, rather than a page offset, and must be a multiple of the page size ie count.
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<27624003&count=10&offset=10

#### Term filtering - ValueSet of all <<763158003 |Medicinal product (product)| containing the word aspirin. This is not case sensitive.
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/<<763158003&filter=Aspirin

#### Refset - list all SNOMED concepts mapped to ICD-O (ECL here is ^446608001 |ICD-O simple map reference set (foundation metadata concept)|)
http://localhost:8080/fhir/ValueSet/$expand?url=http://snomed.info/sct?fhir_vs=ecl/%5E446608001&count=20

## POST Method Request Example(s)

#### Expansion with filter operation using ECL

```
curl --request POST 'http://localhost:8080/fhir/ValueSet/$expand' \
--header 'Content-Type: application/json' \
--data-raw '{
"resourceType": "Parameters",
"parameter": [
{
"name": "valueSet",
"resource": {
"resourceType": "ValueSet",
"compose": {
"include": [
{
"filter": [
{
"property": "concept",
"op": "is-a",
"value": "21351003"
}
]
}
]
}
}
},
{
"name": "system-version",
"valueString": "http://snomed.info/sct/900000000000207008/version/20200731"
},
{
"name": "displayLanguage",
"valueString": "en-GB"
},
{
"name": "offset",
"valueString": "1"
},
{
"name": "count",
"valueString": "5"
}
]
}'
```

#### Expansion with compose which includes one or more other ValueSets

```
curl --request POST 'http://localhost:8080/fhir/ValueSet/$expand' \
--header 'Content-Type: application/json' \
--data-raw '{
"resourceType": "Parameters",
"parameter": [
{
"name": "valueSet",
"resource": {
"resourceType": "ValueSet",
"compose": {
"include": [
{
"valueSet": "http://snomed.info/sct?fhir_vs=ecl/<410607006"
}
]
}
}
}
]
}'
```
Note that the curl --location flag will cause a POST body to be removed if a 302 redirect is encountered, such as happens when an http call is redirected to https.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<groupId>org.snomed</groupId>
<artifactId>snowstorm</artifactId>
<version>7.12.0</version>
<version>7.13.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
Expand Down
Loading