Release 4B Snapshot 3: Connectathon 32 Base

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

Codesystem-example.ttl

Example CodeSystem/example (Turtle)

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 )

Simple Code System 

@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:CodeSystem;
  fhir:Resource.id [ fhir:value "example"];

[a fhir:CodeSystem;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example"]; # 

  fhir:Resource.meta [
     fhir:Meta.profile [
       fhir:value "http://hl7.org/fhir/StructureDefinition/shareablecodesystem";
       fhir:index 0

       fhir:index 0;
       fhir:link <http://hl7.org/fhir/StructureDefinition/shareablecodesystem>

     ]
  ];

  ]; # 

  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/CodeSystem/example"];

     fhir:Narrative.status [ fhir:value "additional" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>CodeSystem &quot;ACME Codes for Cholesterol&quot;: This is an example code system that includes \n        all the codes for serum cholesterol defined by ACME inc.</p>\n      <p>Developed by: FHIR project team (example)</p>\n      <p>Published for testing on 28-Jan 2016</p>\n      <p>This code system defines all the ACME codes for serum cholesterol:</p>\n      <table class=\"grid\">\n        <tr>\n          <td>\n            <b>Code</b>\n          </td>\n          <td>\n            <b>Display</b>\n          </td>\n          <td>\n            <b>Definition</b>\n          </td>\n        </tr>\n        <tr>\n          <td>chol-mmol</td>\n          <td>SChol (mmol/L)</td>\n          <td>Serum Cholesterol, in mmol/L</td>\n        </tr>\n        <tr>\n          <td>chol-mass</td>\n          <td>SChol (mg/L)</td>\n          <td>Serum Cholesterol, in mg/L</td>\n        </tr>\n        <tr>\n          <td>chol</td>\n          <td>SChol</td>\n          <td>Serum Cholesterol</td>\n        </tr>\n      </table>\n    </div>"
  ]; # 
  fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/CodeSystem/example"]; #     
	  for this example, we use a real URI, since this example does have a canonical URL
		at which it's posted. Alternatively, We could have used an OID, or a UUID 

    note that since we give a literal URL here, there's an expectation 
			that accessing that URL will give some form of representation of 
			the full code system, or a pointer about how to get more information. 
	
			This is not an absolute requirement, but it may be enforced by some 
			servers - for instance, the HL7 valueset registry will.    

  fhir:CodeSystem.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.4.1827" ]
  ], [
     fhir:index 1;

     fhir:Identifier.system [ fhir:value "http://acme.com/identifiers/codesystems" ];
     fhir:Identifier.value [ fhir:value "internal-cholesterol-inl" ]
  ];
  fhir:CodeSystem.version [ fhir:value "20160128"];
  fhir:CodeSystem.name [ fhir:value "ACMECholCodesBlood"];
  fhir:CodeSystem.title [ fhir:value "ACME Codes for Cholesterol in Serum/Plasma"];
  fhir:CodeSystem.status [ fhir:value "draft"];
  fhir:CodeSystem.experimental [ fhir:value "true"];
  fhir:CodeSystem.date [ fhir:value "2016-01-28"];
  fhir:CodeSystem.publisher [ fhir:value "Acme Co"];

  ]; #     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:CodeSystem.version [ fhir:value "20160128"]; #     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. Note that you should change the identify of the code 
    system, not the version, if existing codes are redefined (e.g. don't do that!)   
  fhir:CodeSystem.name [ fhir:value "ACMECholCodesBlood"]; # 
  fhir:CodeSystem.title [ fhir:value "ACME Codes for Cholesterol in Serum/Plasma"]; # 
  fhir:CodeSystem.status [ fhir:value "draft"]; # 
  fhir:CodeSystem.experimental [ fhir:value "true"^^xsd:boolean]; # 
  fhir:CodeSystem.date [ fhir:value "2016-01-28"^^xsd:date]; # 
  fhir:CodeSystem.publisher [ fhir:value "Acme Co"]; # 

  fhir:CodeSystem.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:CodeSystem.description [ fhir:value "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36."];
  fhir:CodeSystem.caseSensitive [ fhir:value "true"];
  fhir:CodeSystem.content [ fhir:value "complete"];

  ]; # 
  fhir:CodeSystem.description [ fhir:value "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36."]; # 
  fhir:CodeSystem.caseSensitive [ fhir:value "true"^^xsd:boolean]; #     it's often unstated - are codes case sensitive or not. And 
       it can be the cause of operational or clinical safety problems. 
       So FHIR requires that it always be specified.    
  fhir:CodeSystem.content [ fhir:value "complete"]; # 

  fhir:CodeSystem.filter [
     fhir:index 0;
     fhir:CodeSystem.code [ fhir:value "acme-plasma" ];
     fhir:CodeSystem.description [ fhir:value "An internal filter used to select codes that are only used with plasma" ];
     fhir:CodeSystem.operator [

     fhir:CodeSystem.filter.code [ fhir:value "acme-plasma" ];
     fhir:CodeSystem.filter.description [ fhir:value "An internal filter used to select codes that are only used with plasma" ];
     fhir:CodeSystem.filter.operator [

       fhir:value "=";
       fhir:index 0
     ];
     fhir:CodeSystem.value [ fhir:value "the value of this filter is either 'true' or 'false'" ]
  ];

     fhir:CodeSystem.filter.value [ fhir:value "the value of this filter is either 'true' or 'false'" ]
  ]; #   filter: Code Systems can define filters that value sets can 
    use to select sets of codes. Note that value sets can also use
    properties (see, e.g. the valueset-example-supplement example)
    and this is always preferred because anything asserted as a 
    filter in the code system will need custom code to make it work.
    For this reason, filters are generally only defined in high value 
    published code systems (unlike this extremely low value example)   

  fhir:CodeSystem.concept [
     fhir:index 0;
     fhir:CodeSystem.code [ fhir:value "chol-mmol" ];
     fhir:CodeSystem.display [ fhir:value "SChol (mmol/L)" ];
     fhir:CodeSystem.definition [ fhir:value "Serum Cholesterol, in mmol/L" ];
     fhir:CodeSystem.designation [

     fhir:CodeSystem.concept.code [ fhir:value "chol-mmol" ];
     fhir:CodeSystem.concept.display [ fhir:value "SChol (mmol/L)" ];
     fhir:CodeSystem.concept.definition [ fhir:value "Serum Cholesterol, in mmol/L" ];
     fhir:CodeSystem.concept.designation [

       fhir:index 0;
       fhir:CodeSystem.use [

       fhir:CodeSystem.concept.designation.use [

         fhir:Coding.system [ fhir:value "http://acme.com/config/fhir/codesystems/internal" ];
         fhir:Coding.code [ fhir:value "internal-label" ]
       ];
       fhir:CodeSystem.value [ fhir:value "From ACME POC Testing" ]

       fhir:CodeSystem.concept.designation.value [ fhir:value "From ACME POC Testing" ]

     ]
  ], [
     fhir:index 1;
     fhir:CodeSystem.code [ fhir:value "chol-mass" ];
     fhir:CodeSystem.display [ fhir:value "SChol (mg/L)" ];
     fhir:CodeSystem.definition [ fhir:value "Serum Cholesterol, in mg/L" ];
     fhir:CodeSystem.designation [

     fhir:CodeSystem.concept.code [ fhir:value "chol-mass" ];
     fhir:CodeSystem.concept.display [ fhir:value "SChol (mg/L)" ];
     fhir:CodeSystem.concept.definition [ fhir:value "Serum Cholesterol, in mg/L" ];
     fhir:CodeSystem.concept.designation [

       fhir:index 0;
       fhir:CodeSystem.use [

       fhir:CodeSystem.concept.designation.use [

         fhir:Coding.system [ fhir:value "http://acme.com/config/fhir/codesystems/internal" ];
         fhir:Coding.code [ fhir:value "internal-label" ]
       ];
       fhir:CodeSystem.value [ fhir:value "From Paragon Labs" ]

       fhir:CodeSystem.concept.designation.value [ fhir:value "From Paragon Labs" ]

     ]
  ], [
     fhir:index 2;
     fhir:CodeSystem.code [ fhir:value "chol" ];
     fhir:CodeSystem.display [ fhir:value "SChol" ];
     fhir:CodeSystem.definition [ fhir:value "Serum Cholesterol" ];
     fhir:CodeSystem.designation [

     fhir:CodeSystem.concept.code [ fhir:value "chol" ];
     fhir:CodeSystem.concept.display [ fhir:value "SChol" ];
     fhir:CodeSystem.concept.definition [ fhir:value "Serum Cholesterol" ];
     fhir:CodeSystem.concept.designation [

       fhir:index 0;
       fhir:CodeSystem.use [

       fhir:CodeSystem.concept.designation.use [

         fhir:Coding.system [ fhir:value "http://acme.com/config/fhir/codesystems/internal" ];
         fhir:Coding.code [ fhir:value "internal-label" ]
       ];
       fhir:CodeSystem.value [ fhir:value "Obdurate Labs uses this with both kinds of units..." ]

       fhir:CodeSystem.concept.designation.value [ fhir:value "Obdurate Labs uses this with both kinds of units..." ]

     ]
  ] .

  ]] . #     
			ACME's defined definitions. Note that these are not 
			*good* definitions - but they are very commonly the kind 
			of definitions that are encountered in production
		   

# - 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.