Terminology
This
page
is
part
of
the
Snapshot
#3
for
FHIR
Specification
(v4.3.0:
R4B
-
STU
).
The
current
version
which
supercedes
this
version
is
5.0.0
R5
,
released
to
support
Connectathon
32
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Vocabulary Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Not linked to any defined compartments |
Raw Turtle (+ also see Turtle/RDF Format Specification )
ValueSet Example using a prepared expansion
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource -------------------------------------------------------------------[] a fhir:ValueSet; fhir:Resource.id [ fhir:value "example-expansion"];[a fhir:ValueSet; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "example-expansion"]; # fhir:Resource.meta [ fhir:Meta.profile [ fhir:value "http://hl7.org/fhir/StructureDefinition/shareablevalueset";fhir:index 0 ] ];fhir:index 0; fhir:link <http://hl7.org/fhir/StructureDefinition/shareablevalueset> ] # many expansions are not shareable, but this one is ]; # fhir:DomainResource.text [fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:ValueSet.url [ fhir:value "http://hl7.org/fhir/ValueSet/example-expansion"]; fhir:ValueSet.version [ fhir:value "20150622"]; fhir:ValueSet.name [ fhir:value "LOINC Codes for Cholesterol in Serum/Plasma"]; fhir:ValueSet.status [ fhir:value "draft"]; fhir:ValueSet.experimental [ fhir:value "true"]; fhir:ValueSet.date [ fhir:value "2015-06-22"]; fhir:ValueSet.publisher [ fhir:value "FHIR Project team"];fhir:Narrative.status [ fhir:value "additional" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table class=\"grid\">\n <tr>\n <td>http://loinc.org</td>\n <td>14647-2</td>\n <td>Cholesterol [Moles/volume] in Serum or Plasma</td>\n </tr>\n <tr>\n <td colspan=\"3\">\n <b>Additional Cholesterol codes</b>\n </td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>2093-3</td>\n <td>Cholesterol [Mass/volume] in Serum or Plasma</td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>48620-9</td>\n <td>Cholesterol [Mass/volume] in Serum or Plasma ultracentrifugate</td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>9342-7</td>\n <td>Cholesterol [Percentile]</td>\n </tr>\n <tr>\n <td colspan=\"3\">\n <b>Cholesterol Ratios</b>\n </td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>2096-6</td>\n <td>Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma</td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>35200-5</td>\n <td>Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma</td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>48089-7</td>\n <td>Cholesterol/Apolipoprotein B [Molar ratio] in Serum or Plasma</td>\n </tr>\n <tr>\n <td>http://loinc.org</td>\n <td>55838-7</td>\n <td>Cholesterol/Phospholipid [Molar ratio] in Serum or Plasma</td>\n </tr>\n </table>\n </div>" ]; # fhir:ValueSet.url [ fhir:value "http://hl7.org/fhir/ValueSet/example-expansion"]; # fhir:ValueSet.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.3.3141" ] ]; # fhir:ValueSet.version [ fhir:value "20150622"]; # fhir:ValueSet.name [ fhir:value "LOINCCodesForCholesterolInSerumPlasma"]; # fhir:ValueSet.title [ fhir:value "LOINC Codes for Cholesterol in Serum/Plasma"]; # fhir:ValueSet.status [ fhir:value "draft"]; # fhir:ValueSet.experimental [ fhir:value "true"^^xsd:boolean]; # fhir:ValueSet.date [ fhir:value "2015-06-22"^^xsd:date]; # Expansions that are not intended for persistence often do not have all the metadata. But this one, intended for persistence, does fhir:ValueSet.publisher [ fhir:value "FHIR Project team"]; # fhir:ValueSet.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ]]; fhir:ValueSet.description [ fhir:value "This is an example value set that includes all the LOINC codes for serum/plasma cholesterol from v2.36."]; fhir:ValueSet.copyright [ fhir:value "This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use."];]; # fhir:ValueSet.description [ fhir:value "This is an example value set that includes all the LOINC codes for serum/plasma cholesterol from v2.36."]; # fhir:ValueSet.copyright [ fhir:value "This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use."]; # fhir:ValueSet.compose [fhir:ValueSet.include [fhir:ValueSet.compose.include [ fhir:index 0;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.filter [fhir:ValueSet.compose.include.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.compose.include.filter [ fhir:index 0;fhir:ValueSet.property [ fhir:value "parent" ]; fhir:ValueSet.op [ fhir:value "=" ]; fhir:ValueSet.value [ fhir:value "LP43571-6" ]fhir:ValueSet.compose.include.filter.property [ fhir:value "parent" ]; fhir:ValueSet.compose.include.filter.op [ fhir:value "=" ]; fhir:ValueSet.compose.include.filter.value [ fhir:value "LP43571-6" ] ] ]];]; # it's optional whether to include the content logical definition, but when an expansion is being persisted, it's better to do so (avoids subsequent mystification as to what the intent was) fhir:ValueSet.expansion [ fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expansionSource" ];fhir:Extension.value [ fhir:value "http://hl7.org/fhir/ValueSet/example-extensional" ] ]; fhir:ValueSet.identifier [ fhir:value "urn:uuid:42316ff8-2714-4680-9980-f37a6d1a71bc" ]; fhir:ValueSet.timestamp [ fhir:value "2015-06-22T13:56:07Z" ]; fhir:ValueSet.total [ fhir:value "8" ]; fhir:ValueSet.offset [ fhir:value "0" ]; fhir:ValueSet.parameter [fhir:Extension.valueUri [ fhir:value "http://hl7.org/fhir/ValueSet/example" ] ]; # a reference to the original content - if there is one. Note that \n when you store an expansion, there often won't be one fhir:ValueSet.expansion.identifier [ fhir:value "urn:uuid:42316ff8-2714-4680-9980-f37a6d1a71bc" ]; # always assigned to any expansion, this is cacheable id fhir:ValueSet.expansion.timestamp [ fhir:value "2015-06-22T13:56:07Z"^^xsd:dateTime ]; # this instance of expansion fhir:ValueSet.expansion.total [ fhir:value "8"^^xsd:integer ]; # it's useful to routinely fill out the total fhir:ValueSet.expansion.offset [ fhir:value "0"^^xsd:integer ]; # providing an offset - implies that this expansion was requested using paging - fhir:ValueSet.expansion.parameter [ fhir:index 0;fhir:ValueSet.name [ fhir:value "version" ]; fhir:ValueSet.value [ fhir:value "2.50" ] ]; fhir:ValueSet.contains [fhir:ValueSet.expansion.parameter.name [ fhir:value "version" ]; # for now, parameter names and values are server specific.\n it is likely these will be standardised in a future version.\n \n This example: underlying LOINC version fhir:ValueSet.expansion.parameter.valueString [ fhir:value "2.50" ] ]; # \n now, parameters that describe how the expansion was generated.\n These may help with managing caching, or limit its use \n (e.g. this expansion was generated for a text filter) fhir:ValueSet.expansion.property [ fhir:index 0;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "14647-2" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Moles/volume] in Serum or Plasma" ]fhir:ValueSet.expansion.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.property.uri [ fhir:value "http://loinc.org/property/PROPERTY" ] # used below to connect the values to the property ]; # a property that is included in the expansion , it's up to the server whether to include any properties that weren't asked for in the expansion. , formal definition for the property - highly recommended but not manadatory fhir:ValueSet.expansion.contains [ fhir:index 0; fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; # \n the version can be specified for either the expansion, or\n each individual codes. Technically, these aren't quite the same \n thing, but it would be pretty weird for them to differ using LOINC\n fhir:ValueSet.expansion.contains.code [ fhir:value "14647-2" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol [Moles/volume] in Serum or Plasma" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "SCnc" ] ] ], [ fhir:index 1;fhir:ValueSet.abstract [ fhir:value "true" ]; fhir:ValueSet.display [ fhir:value "Cholesterol codes" ]; fhir:ValueSet.contains [fhir:ValueSet.expansion.contains.abstract [ fhir:value "true"^^xsd:boolean ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol codes" ]; fhir:ValueSet.expansion.contains.contains [ fhir:index 0;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "2093-3" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Mass/volume] in Serum or Plasma" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "2093-3" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol [Mass/volume] in Serum or Plasma" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "SCnc" ] ] ], [ fhir:index 1;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "48620-9" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Mass/volume] in Serum or Plasma ultracentrifugate" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "48620-9" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol [Mass/volume] in Serum or Plasma ultracentrifugate" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "MCnc" ] ] ], [ fhir:index 2;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "9342-7" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Percentile]" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "9342-7" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol [Percentile]" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "Prctl" ] ] ] ], [ fhir:index 2;fhir:ValueSet.abstract [ fhir:value "true" ]; fhir:ValueSet.display [ fhir:value "Cholesterol Ratios" ]; fhir:ValueSet.contains [fhir:ValueSet.expansion.contains.abstract [ fhir:value "true"^^xsd:boolean ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol Ratios" ]; fhir:ValueSet.expansion.contains.contains [ fhir:index 0;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "2096-6" ]; fhir:ValueSet.display [ fhir:value "Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "2096-6" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "SCnc" ] ] ], [ fhir:index 1;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "35200-5" ]; fhir:ValueSet.display [ fhir:value "Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "35200-5" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "SCnc" ] ] ], [ fhir:index 2;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "48089-7" ]; fhir:ValueSet.display [ fhir:value "Cholesterol/Apolipoprotein B [Molar ratio] in Serum or Plasma" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "48089-7" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol/Apolipoprotein B [Molar ratio] in Serum or Plasma" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "SCnc" ] ] ], [ fhir:index 3;fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.50" ]; fhir:ValueSet.code [ fhir:value "55838-7" ]; fhir:ValueSet.display [ fhir:value "Cholesterol/Phospholipid [Molar ratio] in Serum or Plasma" ]fhir:ValueSet.expansion.contains.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.expansion.contains.version [ fhir:value "2.50" ]; fhir:ValueSet.expansion.contains.code [ fhir:value "55838-7" ]; fhir:ValueSet.expansion.contains.display [ fhir:value "Cholesterol/Phospholipid [Molar ratio] in Serum or Plasma" ]; fhir:ValueSet.expansion.contains.property [ fhir:index 0; fhir:ValueSet.expansion.contains.property.code [ fhir:value "PROPERTY" ]; fhir:ValueSet.expansion.contains.property.valueCode [ fhir:value "SCnc" ] ] ]] ] .] # and the actual expansion , \n this expansion is made as a hierarchy - a preferred code, followed by two \n sets of codes categorized by a label. This is to help a human user \n navigate the list (e.g. in a picklist)\n \n Note that the hierarchy might not have anything to do with the\n definitions of the codes (e.g. could be divided into common and less common)\n \n Building a hierarchy like this is not explicitly specified in a standard value set,\n but may be controlled by extensions, the expansion profile, or just performed\n by the expansion service.\n ]] . # ok, and now the expansion # - ontology header ------------------------------------------------------------ [a owl:Ontology; owl:imports fhir:fhir.ttl] . # -------------------------------------------------------------------------------------
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-snapshot3
generated
on
Sat,
May
28,
Wed,
Dec
14,
2022
12:50+1000.
07:13+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change