CodeSystem - FHIR Resource (stu3)


This CodeSystem Resource uses the FHIR API standard for access and structure.

Validate an CodeSystem FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
caseSensitivefalseboolean# If code comparison is case sensitive
compositionalfalseboolean# If code system defines a post-composition grammar
concepttrueData Type# Concepts in the code system
contacttrueContactDetail# Contact details for the publisher
contentfalsecode# not-present | example | fragment | complete
copyrightfalsemarkdown# Use and/or publishing restrictions
countfalseunsignedInt# Total concepts in the code system
datefalsedateTime# Date this was last changed
descriptionfalsemarkdown# Natural language description of the code system
experimentalfalseboolean# For testing purposes, not real usage
filtertrueData Type# Filter that can be used in a value set
hierarchyMeaningfalsecode# grouped-by | is-a | part-of | classified-with
identifierfalseIdentifier# Additional identifier for the code system
jurisdictiontrueCodeableConcept# Intended jurisdiction for code system (if applicable)
namefalsestring# Name for this code system (computer friendly)
propertytrueData Type# Additional information supplied about each concept
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this code system is defined
statusfalsecode# draft | active | retired | unknown
titlefalsestring# Name for this code system (human friendly)
urlfalseuri# Logical URI to reference this code system (globally unique) (Coding.system)
useContexttrueUsageContext# Context the content is intended to support
valueSetfalseuri# Canonical URL for value set with entire code system
versionfalsestring# Business version of the code system (Coding.version)
versionNeededfalseboolean# If definitions are not stable

CodeSystem Example

{
  "status": "draft",
  "publisher": "HL7 International",
  "concept": [
    {
      "definition": "Serum Cholesterol, in mmol/L",
      "code": "chol-mmol",
      "display": "SChol (mmol/L)",
      "designation": [
        {
          "use": {
            "code": "internal-label",
            "system": "http://acme.com/config/fhir/codesystems/internal"
          },
          "value": "From ACME POC Testing"
        }
      ]
    },
    {
      "definition": "Serum Cholesterol, in mg/L",
      "code": "chol-mass",
      "display": "SChol (mg/L)",
      "designation": [
        {
          "use": {
            "code": "internal-label",
            "system": "http://acme.com/config/fhir/codesystems/internal"
          },
          "value": "From Paragon Labs"
        }
      ]
    },
    {
      "definition": "Serum Cholesterol",
      "code": "chol",
      "display": "SChol",
      "designation": [
        {
          "use": {
            "code": "internal-label",
            "system": "http://acme.com/config/fhir/codesystems/internal"
          },
          "value": "Obdurate Labs uses this with both kinds of units..."
        }
      ]
    }
  ],
  "version": "20160128",
  "caseSensitive": true,
  "resourceType": "CodeSystem",
  "text": {
    "status": "generated",
    "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>"
  },
  "description": "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36.",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ],
      "name": "FHIR project team"
    }
  ],
  "content": "complete",
  "url": "http://hl7.org/fhir/CodeSystem/example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
    ]
  },
  "date": "2016-01-28",
  "identifier": {
    "system": "http://acme.com/identifiers/codesystems",
    "value": "internal-cholesterol-inl"
  },
  "id": "example",
  "experimental": true,
  "name": "ACME Codes for Cholesterol in Serum/Plasma"
}

CodeSystem Structure


  
{
  "resourceType" : "CodeSystem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this code system (globally unique) (Coding.system)
  "identifier" : { Identifier }, // Additional identifier for the code system
  "version" : "<string>", // Business version of the code system (Coding.version)
  "name" : "<string>", // 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 this was 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 }], // Context 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" : "<uri>", // Canonical URL for value set with entire code system
  "hierarchyMeaning" : "<code>", // grouped-by | is-a | part-of | classified-with
  "compositional" : <boolean>, // If code system defines a post-composition grammar
  "versionNeeded" : <boolean>, // If definitions are not stable
  "content" : "<code>", // R!  not-present | example | fragment | complete
  "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!  Operators that can be used with filter
    "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
  }],
  "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 6:
      "valueCode" : "<code>"
      "valueCoding" : { Coding }
      "valueString" : "<string>"
      "valueInteger" : <integer>
      "valueBoolean" : <boolean>
      "valueDateTime" : "<dateTime>"
    }],
    "concept" : [{ Content as for CodeSystem.concept }] // Child Concepts (is-a/contains/categorizes)
  }]
}


 

CodeSystem Search Parameters

The following search parameters can be used to query CodeSystem resources. Just submit the like so:

https://api.1up.health/fhir/stu3/CodeSystem?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextconcept.code
content-modetextcontent
datedatedate
descriptiontextdescription
identifiertextidentifier
jurisdictiontextjurisdiction
languagetextconcept.designation.language
nametextname
publishertextpublisher
statustextstatus
systemuriurl
titletexttitle
urluriurl
versiontextversion