Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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: R4B R4

Valueset-example-hierarchical.ttl

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw Turtle (+ also see Turtle/RDF Format Specification)

ValueSet Example showing how to specify a hierarchy for UI using extensions

@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

# - resource -------------------------------------------------------------------

[] a fhir:ValueSet;
  fhir:Resource.id [ fhir:value "example-hierarchical"], [ fhir:value "hacked"];
  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-hierarchical"];
  fhir:ValueSet.version [ fhir:value "4.3.0"];
  fhir:ValueSet.name [ fhir:value "Example Hierarchical ValueSet"];
  fhir:ValueSet.status [ fhir:value "draft"];
  fhir:ValueSet.experimental [ fhir:value "true"];
  fhir:ValueSet.date [ fhir:value "2018-07-20"];
  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 "Demonstration of extensions that build a hierarchical contains"];
  fhir:ValueSet.compose [
     fhir:ValueSet.include [
       fhir:index 0;
       fhir:Element.extension [
         fhir:index 0;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expand-rules" ];
         fhir:Extension.value [ fhir:value "groups-only" ]
       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "display" ];
           fhir:Extension.value [ fhir:value "(Most common)" ]
         ], [
           fhir:index 1;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "login" ]
         ], [
           fhir:index 2;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "conflict" ]
         ];
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expand-group" ]
       ], [
         fhir:index 2;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "code" ];
           fhir:Extension.value [ fhir:value "processing" ]
         ], [
           fhir:index 1;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "duplicate" ]
         ], [
           fhir:index 2;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "not-found" ]
         ];
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expand-group" ]
       ], [
         fhir:index 3;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "code" ];
           fhir:Extension.value [ fhir:value "invalid" ]
         ], [
           fhir:index 1;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "structure" ]
         ], [
           fhir:index 2;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "required" ]
         ], [
           fhir:index 3;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "value" ]
         ];
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expand-group" ]
       ], [
         fhir:index 4;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "code" ];
           fhir:Extension.value [ fhir:value "transient" ]
         ], [
           fhir:index 1;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "lock" ]
         ], [
           fhir:index 2;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "exception" ]
         ], [
           fhir:index 3;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "throttled" ]
         ];
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expand-group" ]
       ], [
         fhir:index 5;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "code" ];
           fhir:Extension.value [ fhir:value "security" ]
         ], [
           fhir:index 1;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "login" ]
         ], [
           fhir:index 2;
           fhir:Extension.url [ fhir:value "member" ];
           fhir:Extension.value [ fhir:value "unknown" ]
         ];
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/valueset-expand-group" ]
       ];
       fhir:ValueSet.system [ fhir:value "#hacked" ];
       fhir:ValueSet.concept [
         fhir:index 0;
         fhir:ValueSet.code [ fhir:value "invalid" ]
       ], [
         fhir:index 1;
         fhir:ValueSet.code [ fhir:value "structure" ]
       ], [
         fhir:index 2;
         fhir:ValueSet.code [ fhir:value "required" ]
       ], [
         fhir:index 3;
         fhir:ValueSet.code [ fhir:value "value" ]
       ], [
         fhir:index 4;
         fhir:ValueSet.code [ fhir:value "processing" ]
       ], [
         fhir:index 5;
         fhir:ValueSet.code [ fhir:value "duplicate" ]
       ], [
         fhir:index 6;
         fhir:ValueSet.code [ fhir:value "not-found" ]
       ], [
         fhir:index 7;
         fhir:ValueSet.code [ fhir:value "conflict" ]
       ], [
         fhir:index 8;
         fhir:ValueSet.code [ fhir:value "lock" ]
       ], [
         fhir:index 9;
         fhir:ValueSet.code [ fhir:value "exception" ]
       ], [
         fhir:index 10;
         fhir:ValueSet.code [ fhir:value "tbrottled" ]
       ], [
         fhir:index 11;
         fhir:ValueSet.code [ fhir:value "login" ]
       ], [
         fhir:index 12;
         fhir:ValueSet.code [ fhir:value "unknown" ]
       ]
     ]
  ];
  fhir:ValueSet.expansion [
     fhir:ValueSet.identifier [ fhir:value "urn:uuid:42316ff8-2714-4680-9980-f37a6d1a71bc" ];
     fhir:ValueSet.timestamp [ fhir:value "2018-07-20T23:14:07+10:00" ];
     fhir:ValueSet.parameter [
       fhir:index 0;
       fhir:ValueSet.name [ fhir:value "excludeNotForUI" ];
       fhir:ValueSet.value [ fhir:value "false" ]
     ];
     fhir:ValueSet.contains [
       fhir:index 0;
       fhir:ValueSet.abstract [ fhir:value "true" ];
       fhir:ValueSet.display [ fhir:value "(Most common)" ];
       fhir:ValueSet.contains [
         fhir:index 0;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "login" ];
         fhir:ValueSet.display [ fhir:value "Login Required" ]
       ], [
         fhir:index 1;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "conflict" ];
         fhir:ValueSet.display [ fhir:value "Edit Version Conflict" ]
       ]
     ], [
       fhir:index 1;
       fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
       fhir:ValueSet.code [ fhir:value "processing" ];
       fhir:ValueSet.display [ fhir:value "Processing Failure" ];
       fhir:ValueSet.contains [
         fhir:index 0;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "duplicate" ];
         fhir:ValueSet.display [ fhir:value "Duplicate" ]
       ], [
         fhir:index 1;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "not-found" ];
         fhir:ValueSet.display [ fhir:value "Not Found" ]
       ]
     ], [
       fhir:index 2;
       fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
       fhir:ValueSet.abstract [ fhir:value "true" ];
       fhir:ValueSet.code [ fhir:value "invalid" ];
       fhir:ValueSet.display [ fhir:value "Invalid Content" ];
       fhir:ValueSet.contains [
         fhir:index 0;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "structure" ];
         fhir:ValueSet.display [ fhir:value "Structural Issue" ]
       ], [
         fhir:index 1;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "required" ];
         fhir:ValueSet.display [ fhir:value "Required element missing" ]
       ], [
         fhir:index 2;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "value" ];
         fhir:ValueSet.display [ fhir:value "Element value invalid" ]
       ]
     ], [
       fhir:index 3;
       fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
       fhir:ValueSet.abstract [ fhir:value "true" ];
       fhir:ValueSet.code [ fhir:value "transient" ];
       fhir:ValueSet.display [ fhir:value "Transient Issue" ];
       fhir:ValueSet.contains [
         fhir:index 0;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "lock-error" ];
         fhir:ValueSet.display [ fhir:value "Lock Error" ]
       ], [
         fhir:index 1;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "exception" ];
         fhir:ValueSet.display [ fhir:value "Exception" ]
       ], [
         fhir:index 2;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "throttled" ];
         fhir:ValueSet.display [ fhir:value "Throttled" ]
       ]
     ], [
       fhir:index 4;
       fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
       fhir:ValueSet.abstract [ fhir:value "true" ];
       fhir:ValueSet.code [ fhir:value "security" ];
       fhir:ValueSet.display [ fhir:value "Security Problem" ];
       fhir:ValueSet.contains [
         fhir:index 0;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "login" ];
         fhir:ValueSet.display [ fhir:value "Login Required" ]
       ], [
         fhir:index 1;
         fhir:ValueSet.system [ fhir:value "http://hl7.org/fhir/hacked" ];
         fhir:ValueSet.code [ fhir:value "unknown" ];
         fhir:ValueSet.display [ fhir:value "Unknown User" ]
       ]
     ]
  ] .

# -------------------------------------------------------------------------------------


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.