This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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
Simple Code System
{ "resourceType": "CodeSystem", "id": "example", "meta": { "profile": [ "http://hl7.org/fhir/StructureDefinition/codesystem-shareable-definition" ] }, "text": { "status": "generated", "div": "<div>\n <p>CodeSystem "ACME Codes for Cholesterol": 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>" }, "url": "http://hl7.org/fhir/CodeSystem/example", "_url": { "fhir_comments": [ " \n\t for this example, we use a real URI, since this example does have a canonical address\n\t\tat which it's posted. Alternatively, We could have used an OID, or a UUID \n\n note that since we give a literal URL here, there's an expectation \n\t\t\tthat accessing that URL will give some form of representation of \n\t\t\tthe full code system, or a pointer about how to get more infomration. \n\t\n\t\t\tThis is not an absolute requirement, but it may be enforced by some \n\t\t\tservers - for instance, the HL7 valueset registry will. " ] }, "identifier": { "fhir_comments": [ " an imaginary identifier. This is a non FHIR identifier - might be used in a \n\t v2 context (though you always need to translate namespaces for v2) " ], "system": "http://acme.com/identifiers/codesystems", "value": "internal-cholesterol-inl" }, "version": "20160128", "_version": { "fhir_comments": [ " for version, we are going to simply use the day of publication. This is also \n arbitrary - whatever is here is what people use to refer to the version. \n Could also be a UUID too. Note that you should change the identify of the code \n system, not the version, if existing codes are redefined (e.g. don't do that!) " ] }, "name": "ACME Codes for Cholesterol in Serum/Plasma", "status": "draft", "experimental": true, "publisher": "HL7 International", "contact": [ { "name": "FHIR project team", "telecom": [ { "system": "other", "value": "http://hl7.org/fhir" } ] } ], "date": "2016-01-28", "description": "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36.", "caseSensitive": true, "_caseSensitive": { "fhir_comments": [ " it's often unstated - are codes case sensitive or not. And \n it can be the cause of operational or clinical safety problems. \n So FHIR requires that it always be specified. " ] }, "content": "complete", "concept": [ { "fhir_comments": [ " \n\t\t\tACME's defined definitions. Note that these are not \n\t\t\t*good* definitions - but they are very commonly the kind \n\t\t\tof definitions that are encountered in production\n\t\t " ], "code": "chol-mmol", "display": "SChol (mmol/L)", "definition": "Serum Cholesterol, in mmol/L", "designation": [ { "use": { "system": "http://acme.com/config/fhir/codesystems/internal", "code": "internal-label" }, "value": "From ACME POC Testing" } ] }, { "code": "chol-mass", "display": "SChol (mg/L)", "definition": "Serum Cholesterol, in mg/L", "designation": [ { "use": { "system": "http://acme.com/config/fhir/codesystems/internal", "code": "internal-label" }, "value": "From Paragon Labs" } ] }, { "code": "chol", "display": "SChol", "definition": "Serum Cholesterol", "designation": [ { "use": { "system": "http://acme.com/config/fhir/codesystems/internal", "code": "internal-label" }, "value": "Obdurate Labs uses this with both kinds of units..." } ] } ] }
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.