CodeSystem - FHIR Resource (stu3)

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

Validate an CodeSystem FHIR Resource (stu3)

CodeSystem Attributes

AttributeField is listTypeDescription

Description: Concepts in the code system

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"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..."
      }
    ]
  }
]

Learn more about the (CodeSystem) concept FHIR attribute

Description: Canonical URL for value set with entire code system

FHIR Version: stu3

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"valueSet":

Learn more about the (CodeSystem) valueSet FHIR attribute

Description: Intended jurisdiction for code system (if applicable)

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction":

Learn more about the (CodeSystem) jurisdiction FHIR attribute

Description: If code comparison is case sensitive

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"caseSensitive": true

Learn more about the (CodeSystem) caseSensitive FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: stu3

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright":

Learn more about the (CodeSystem) copyright FHIR attribute

Description: Name for this code system (human friendly)

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title":

Learn more about the (CodeSystem) title FHIR attribute

Description: not-present | example | fragment | complete

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"content": "complete"

Learn more about the (CodeSystem) content FHIR attribute

Description: Business version of the code system (Coding.version)

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "20160128"

Learn more about the (CodeSystem) version FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (CodeSystem) status FHIR attribute

Description: Natural language description of the code system

FHIR Version: stu3

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "This is an example code system that includes all the ACME codes for serum/plasma cholesterol from v2.36."

Learn more about the (CodeSystem) description FHIR attribute

Description: Context the content is intended to support

FHIR Version: stu3

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext":

Learn more about the (CodeSystem) useContext FHIR attribute

Description: Why this code system is defined

FHIR Version: stu3

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose":

Learn more about the (CodeSystem) purpose FHIR attribute

Description: grouped-by | is-a | part-of | classified-with

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"hierarchyMeaning":

Learn more about the (CodeSystem) hierarchyMeaning FHIR attribute

Description: Date this was last changed

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2016-01-28"

Learn more about the (CodeSystem) date FHIR attribute

Description: Total concepts in the code system

FHIR Version: stu3

Attribute Type : unsignedInt

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"count":

Learn more about the (CodeSystem) count FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "HL7 International"

Learn more about the (CodeSystem) publisher FHIR attribute

Description: Additional identifier for the code system

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": {
  "system": "http://acme.com/identifiers/codesystems",
  "value": "internal-cholesterol-inl"
}

Learn more about the (CodeSystem) identifier FHIR attribute

Description: Name for this code system (computer friendly)

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "ACME Codes for Cholesterol in Serum/Plasma"

Learn more about the (CodeSystem) name FHIR attribute

Description: If code system defines a post-composition grammar

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"compositional":

Learn more about the (CodeSystem) compositional FHIR attribute

Description: Filter that can be used in a value set

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"filter":

Learn more about the (CodeSystem) filter FHIR attribute

Description: Logical URI to reference this code system (globally unique) (Coding.system)

FHIR Version: stu3

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://hl7.org/fhir/CodeSystem/example"

Learn more about the (CodeSystem) url FHIR attribute

Description: Contact details for the publisher

FHIR Version: stu3

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "telecom": [
      {
        "system": "url",
        "value": "http://hl7.org/fhir"
      }
    ],
    "name": "FHIR project team"
  }
]

Learn more about the (CodeSystem) contact FHIR attribute

Description: If definitions are not stable

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"versionNeeded":

Learn more about the (CodeSystem) versionNeeded FHIR attribute

Description: Additional information supplied about each concept

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"property":

Learn more about the (CodeSystem) property FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental": true

Learn more about the (CodeSystem) experimental FHIR attribute

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 them like so:

https://api.1up.health/fhir/stu3/CodeSystem?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`code`	`text`	`concept.code`
`content-mode`	`text`	`content`
`date`	`date`	`date`
`description`	`text`	`description`
`identifier`	`text`	`identifier`
`jurisdiction`	`text`	`jurisdiction`
`language`	`text`	`concept.designation.language`
`name`	`text`	`name`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`system`	`uri`	`url`
`title`	`text`	`title`
`url`	`uri`	`url`
`version`	`text`	`version`