"url": "http://hl7.org/fhir/CodeSystem/example"
"identifier": [
{
"system": "http://acme.com/identifiers/codesystems",
"value": "internal-cholesterol-inl"
}
]
"version": "20160128"
"name": "ACMECholCodesBlood"
"title": "ACME Codes for Cholesterol in Serum/Plasma"
"status": "draft"
"experimental": true
"date": "2016-01-28"
"publisher": "Acme Co"
"contact": [
{
"name": "FHIR project team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
]
"description": "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36."
"useContext":
"jurisdiction":
"purpose":
"copyright":
"caseSensitive": true
"valueSet":
"hierarchyMeaning":
"compositional":
"versionNeeded":
"content": "complete"
"supplements":
"count":
"filter": [
{
"code": "acme-plasma",
"description": "An internal filter used to select codes that are only used with plasma",
"operator": [
"="
],
"value": "the value of this filter is either 'true' or 'false'"
}
]
"property":
"concept": [
{
"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..."
}
]
}
]
{
"resourceType": "CodeSystem",
"id": "example",
"meta": {
"profile": [
"http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\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",
"identifier": [
{
"system": "http://acme.com/identifiers/codesystems",
"value": "internal-cholesterol-inl"
}
],
"version": "20160128",
"name": "ACMECholCodesBlood",
"title": "ACME Codes for Cholesterol in Serum/Plasma",
"status": "draft",
"experimental": true,
"date": "2016-01-28",
"publisher": "Acme Co",
"contact": [
{
"name": "FHIR project team",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36.",
"caseSensitive": true,
"content": "complete",
"filter": [
{
"code": "acme-plasma",
"description": "An internal filter used to select codes that are only used with plasma",
"operator": [
"="
],
"value": "the value of this filter is either 'true' or 'false'"
}
],
"concept": [
{
"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..."
}
]
}
]
}
{
"resourceType" : "CodeSystem",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
"identifier" : [{ Identifier }], // Additional identifier for the code system (business identifier)
"version" : "<string>", // Business version of the code system (Coding.version)
"name" : "<string>", // C? Name for this code system (computer friendly)
"title" : "<string>", // Name for this code system (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the code system
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for code system (if applicable)
"purpose" : "<markdown>", // Why this code system is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"caseSensitive" : <boolean>, // If code comparison is case sensitive
"valueSet" : { canonical(ValueSet) }, // Canonical reference to the value set with entire code system
"hierarchyMeaning" : "<code>", // grouped-by | is-a | part-of | classified-with
"compositional" : <boolean>, // If code system defines a compositional grammar
"versionNeeded" : <boolean>, // If definitions are not stable
"content" : "<code>", // R! not-present | example | fragment | complete | supplement
"supplements" : { canonical(CodeSystem) }, // Canonical URL of Code System this adds designations and properties to
"count" : "<unsignedInt>", // Total concepts in the code system
"filter" : [{ // Filter that can be used in a value set
"code" : "<code>", // R! Code that identifies the filter
"description" : "<string>", // How or why the filter is used
"operator" : ["<code>"], // R! = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
"value" : "<string>" // R! What to use for the value
}],
"property" : [{ // Additional information supplied about each concept
"code" : "<code>", // R! Identifies the property on the concepts, and when referred to in operations
"uri" : "<uri>", // Formal identifier for the property
"description" : "<string>", // Why the property is defined, and/or what it conveys
"type" : "<code>" // R! code | Coding | string | integer | boolean | dateTime | decimal
}],
"concept" : [{ // Concepts in the code system
"code" : "<code>", // R! Code that identifies concept
"display" : "<string>", // Text to display to the user
"definition" : "<string>", // Formal definition
"designation" : [{ // Additional representations for the concept
"language" : "<code>", // Human language of the designation
"use" : { Coding }, // Details how this designation would be used
"value" : "<string>" // R! The text value for this designation
}],
"property" : [{ // Property value for the concept
"code" : "<code>", // R! Reference to CodeSystem.property.code
// value[x]: Value of the property for this concept. One of these 7:
"valueCode" : "<code>"
"valueCoding" : { Coding }
"valueString" : "<string>"
"valueInteger" : <integer>
"valueBoolean" : <boolean>
"valueDateTime" : "<dateTime>"
"valueDecimal" : <decimal>
}],
"concept" : [{ Content as for CodeSystem.concept }] // Child Concepts (is-a/contains/categorizes)
}]
}
The following search parameters can be used to query CodeSystem resources. Just submit them like so:
https://api.1up.health/fhir/r4/CodeSystem?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|---|---|
code TU | text | concept.code |
content-mode TU | text | content |
context TU | text | useContext.value |
context-quantity TU | quantity | useContext.value |
context-type TU | text | useContext.code |
context-type-quantity TU | composite | useContext |
context-type-value TU | composite | useContext |
date TU | date | date |
description TU | text | description |
identifier TU | text | identifier |
jurisdiction TU | text | jurisdiction |
language TU | text | concept.designation.language |
name TU | text | name |
publisher TU | text | publisher |
status TU | text | status |
supplements TU | reference | supplements |
system TU | uri | url |
title TU | text | title |
url TU | uri | url |
version TU | text | version |