CodeSystem
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/CodeSystem| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/CodeSystem/[id] |
| Vread | GET | /fhir/R4/CodeSystem/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/CodeSystem/[id] |
| Patch | PATCH | /fhir/R4/CodeSystem/[id] |
| Delete | DELETE | /fhir/R4/CodeSystem/[id] |
| Create | POST | /fhir/R4/CodeSystem |
| Search | GET | /fhir/R4/CodeSystem |
| History | GET | /fhir/R4/CodeSystem/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
identifier | Identifier | 0..* | Additional identifier for the code system (business identifier) |
version | string | 0..1 | Business version of the code system (Coding.version) |
name | string | 0..1 | Name for this code system (computer friendly) |
title | string | 0..1 | Name for this code system (human friendly) |
status | code | 1..1 | draft | active | retired | unknown modifier |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the code system |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for code system (if applicable) |
purpose | markdown | 0..1 | Why this code system is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
caseSensitive | boolean | 0..1 | If code comparison is case sensitive |
valueSet | canonical | 0..1 | Canonical reference to the value set with entire code system |
hierarchyMeaning | code | 0..1 | grouped-by | is-a | part-of | classified-with |
compositional | boolean | 0..1 | If code system defines a compositional grammar |
versionNeeded | boolean | 0..1 | If definitions are not stable |
content | code | 1..1 | not-present | example | fragment | complete | supplement |
supplements | canonical | 0..1 | Canonical URL of Code System this adds designations and properties to |
count | unsignedInt | 0..1 | Total concepts in the code system |
filter | BackboneElement | 0..* | Filter that can be used in a value set |
property | BackboneElement | 0..* | Additional information supplied about each concept |
concept | BackboneElement | 0..* | Concepts in the code system |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
CodeSystem - Maturity: Normative (FMM 5).