Terminology
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
STU
see
ballot
notes
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
|
|
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 enumeration of codes (extensional)
@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-extensional"]; fhir:Resource.meta [ fhir:Meta.profile [ fhir:value "http://hl7.org/fhir/StructureDefinition/shareablevalueset"; fhir:index 0 ] ]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:ValueSet.url [ fhir:value "http://hl7.org/fhir/ValueSet/example-extensional"]; fhir:ValueSet.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "http://acme.com/identifiers/valuesets" ]; fhir:Identifier.value [ fhir:value "loinc-cholesterol-int" ] ]; 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 "HL7 International"]; fhir:ValueSet.contact [ fhir:index 0; fhir:ContactDetail.name [ fhir:value "FHIR project team" ]; 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.useContext [ fhir:index 0; fhir:UsageContext.code [ fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/usage-context-type" ]; fhir:Coding.code [ fhir:value "age" ] ]; fhir:UsageContext.value [ fhir:Quantity.value [ fhir:value "18" ]; fhir:Quantity.comparator [ fhir:value ">" ]; fhir:Quantity.unit [ fhir:value "yrs" ]; fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ]; fhir:Quantity.code [ fhir:value "a" ] ] ]; fhir:ValueSet.jurisdiction [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ]; fhir:Coding.code [ fhir:value "US" ] ] ]; fhir:ValueSet.purpose [ fhir:value "This value set was published by ACME Inc in order to make clear which codes are used for Cholesterol by AcmeClinicals (Adult Ambulatory care support in USA)"]; 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.lockedDate [ fhir:value "2012-06-13" ]; fhir:ValueSet.inactive [ fhir:value "true" ]; fhir:ValueSet.include [ fhir:index 0; fhir:ValueSet.system [ fhir:value "http://loinc.org" ]; fhir:ValueSet.version [ fhir:value "2.36" ]; fhir:ValueSet.concept [ fhir:index 0; fhir:ValueSet.code [ fhir:value "14647-2" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Moles/Volume]" ] ], [ fhir:index 1; fhir:ValueSet.code [ fhir:value "2093-3" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Mass/Volume]" ] ], [ fhir:index 2; fhir:ValueSet.code [ fhir:value "35200-5" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Mass Or Moles/Volume]" ] ], [ fhir:index 3; fhir:ValueSet.code [ fhir:value "9342-7" ]; fhir:ValueSet.display [ fhir:value "Cholesterol [Percentile]" ] ][a fhir:ValueSet ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "example"] ; # fhir:meta [ fhir:profile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/shareablevalueset"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/StructureDefinition/shareablevalueset> ] ) # shareable value sets are fully described, and can be put in the HL7 registry ] ; # fhir:text [ fhir:status [ fhir:v "additional" ] ; fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Value set "LOINC Codes for Cholesterol": This is an example value set that includes \n all the codes for serum cholesterol from LOINC v2.36.</p>\n <p>Developed by: FHIR project team (example)</p>\n <p>Published for testing on 13-June 2012</p>\n <p>This value set includes the following LOINC codes:</p>\n <ul>\n <li>14647-2: Cholesterol [Moles/Volume]</li>\n <li>2093-3: Cholesterol [Mass/Volume]</li>\n <li>35200-5: Cholesterol [Mass Or Moles/Volume] </li>\n <li>9342-7: Cholesterol [Percentile]</li>\n </ul>\n <p>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.</p>\n </div>" ] ; # fhir:url [ fhir:v "http://hl7.org/fhir/ValueSet/example"^^xsd:anyURI] ; # # for this example, we use a real URI, since this example does have a canonical address # at which it's posted. Alternatively, We could have used an OID, or a UUID. # # Mote that this isn't the identifier for the LOINC codes themeselves - they belong to LOINC, and # it has its own identifier. This is the identifier for this set of codes, and that doesn't # change the codes. # fhir:identifier ( [ fhir:system [ fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ] ; fhir:value [ fhir:v "urn:oid:2.16.840.1.113883.4.642.3.3292" ] ] [ fhir:system [ fhir:v "http://acme.com/identifiers/valuesets"^^xsd:anyURI ] ; fhir:value [ fhir:v "loinc-cholesterol-int" ] ] ) ; # an imaginary identifier. This is a non FHIR identifier - might be used in a # v2 context (though you always need to translate namespaces for v2) fhir:version [ fhir:v "20150622"] ; # for version, we are going to simply use the day of publication. This is also # arbitrary - whatever is here is what people use to refer to the version. # Could also be a UUID too fhir:name [ fhir:v "LOINCCodesForCholesterolInSerumPlasma"] ; # set of loinc codes for cholesterol for LONC 2.36 fhir:title [ fhir:v "LOINC Codes for Cholesterol in Serum/Plasma"] ; # fhir:status [ fhir:v "draft"] ; # fhir:experimental [ fhir:v "true"^^xsd:boolean] ; # fhir:date [ fhir:v "2015-06-22"^^xsd:date] ; # fhir:publisher [ fhir:v "HL7 International"] ; # fhir:contact ( [ fhir:name [ fhir:v "FHIR project team" ] ; fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://hl7.org/fhir" ] ] ) ] ) ; # fhir:description [ fhir:v "This is an example value set that includes all the LOINC codes for serum/plasma cholesterol from v2.36."] ; # fhir:useContext ( [ fhir:code [ fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/usage-context-type"^^xsd:anyURI ] ; fhir:code [ fhir:v "age" ] ] ; fhir:value [ a fhir:Quantity ; fhir:value [ fhir:v "18"^^xsd:decimal ] ; fhir:comparator [ fhir:v ">" ] ; fhir:unit [ fhir:v "yrs" ] ; fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ; fhir:code [ fhir:v "a" ] ]] .] ) ; # fhir:jurisdiction ( [ fhir:coding ( [ fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ; fhir:code [ fhir:v "US" ] ] ) ] ) ; # fhir:purpose [ fhir:v "This value set was published by ACME Inc in order to make clear which codes are used for Cholesterol by AcmeClinicals (Adult Ambulatory care support in USA)"] ; # fhir:copyright [ fhir:v "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:compose [ fhir:lockedDate [ fhir:v "2012-06-13"^^xsd:date ] ; # \n if we didn't specify the version of LOINC on the include, then\n we could specify it implicitly by specifying the locked date for the value set\n \n So we show this example here, but it's not actually necessary since we also \n have LOINC version. Note: if you do what this example does, and specify both,\n you better get it right, and specify the current version of LOINC at the time\n fhir:inactive [ fhir:v "true"^^xsd:boolean ] ; # \n Including inactive codes means that retired and deprecated codes may still be used in the\n value set. Note that not all retired or deprecated codes are explicitly marked 'inactive' - this \n is a matter of code system policy\n fhir:include ( [ fhir:system [ fhir:v "http://loinc.org"^^xsd:anyURI ] ; fhir:version [ fhir:v "2.36" ] ; fhir:concept ( [ fhir:code [ fhir:v "14647-2" ] ; fhir:display [ fhir:v "Cholesterol [Moles/Volume]" ] # \n In this value set, we provide our own displays. \n \n You have to be very careful doing this; it's all too \n easy to specify a different or lesser meaning, and then\n people use codes wrongly ()with obvious consequences for clinical safety)\n \n You're allowed to do this in a value set for 2 reasons:\n - people do it anyway\n - it does make sense to remove common text that's fixed in the context\n \n In this case, that's what we're doing here - removing\n 'serum\/plasma' from the names, since that's specified in the\n value set name ] [ fhir:code [ fhir:v "2093-3" ] ; fhir:display [ fhir:v "Cholesterol [Mass/Volume]" ] ] [ fhir:code [ fhir:v "35200-5" ] ; fhir:display [ fhir:v "Cholesterol [Mass Or Moles/Volume]" ] ] [ fhir:code [ fhir:v "9342-7" ] ; fhir:display [ fhir:v "Cholesterol [Percentile]" ] ] ) # for LOINC, we simply include the listed codes - no subsumption in LOINC , these were selected by hand ] ) # you could have multiple includes, if you wanted to include codes from more than\n one code system, or include codes with different modes. we don't, in this case ]] . # # -------------------------------------------------------------------------------------
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
hl7.fhir.core#5.0.0-draft-final
generated
on
Sat,
May
28,
2022
12:50+1000.
Wed,
Mar
1,
2023
23:05+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change