ShareableCodeSystem
Shareable CodeSystem
draftResource82 elementsv5.0.0
Enforces the minimum information set for the code system metadata required by HL7 and other organizations that share and publish code systems
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/shareablecodesystem
- ID
- shareablecodesystem
- Type
- Base Definition
- Derivation
- constraint
- Publisher
- HL7
- Version
- 5.0.0
| Path | Card. | Type | Description |
|---|---|---|---|
CodeSystem | 1..1 | Declares the existence of and describes a code system or code system supplement | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | Metadata about the resource | |
implicitRules | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource contentrequired: all-languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Extension | |
extension | 0..* | narrative | semi-structured | structured | executable | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
url | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
identifier | 0..* | Additional identifier for the code system (business identifier) | |
version | 1..1 | string | Business version of the code system (Coding.version) |
versionAlgorithm[x] | 0..1 | stringCoding | How to compare versionsextensible: version-algorithm |
name | 0..1 | string | Name for this code system (computer friendly) |
title | 1..1 | string | Name for this code system (human friendly) |
status | 1..1 | code | draft | active | retired | unknownrequired: publication-status |
experimental | 1..1 | boolean | For testing purposes, not real usage |
date | 0..1 | dateTime | Date last changed |
publisher | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | 0..* | Contact details for the publisher | |
description | 1..1 | markdown | Natural language description of the code system |
useContext | 0..* | The context that the content is intended to support | |
jurisdiction | 0..* | Intended jurisdiction for code system (if applicable)extensible: jurisdiction | |
purpose | 0..1 | markdown | Why this code system is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | 0..1 | string | Copyright holder and year(s) |
approvalDate | 0..1 | date | When the CodeSystem was approved by publisher |
lastReviewDate | 0..1 | date | When the CodeSystem was last reviewed by the publisher |
effectivePeriod | 0..1 | When the CodeSystem is expected to be used | |
topic | 0..* | E.g. Education, Treatment, Assessment, etcexample: definition-topic | |
author | 0..* | Who authored the CodeSystem | |
editor | 0..* | Who edited the CodeSystem | |
reviewer | 0..* | Who reviewed the CodeSystem | |
endorser | 0..* | Who endorsed the CodeSystem | |
relatedArtifact | 0..* | Additional documentation, citations, etc | |
caseSensitive | 1..1 | boolean | If code comparison is case sensitive |
valueSet | 0..1 | canonical | Canonical reference to the value set with entire code system |
hierarchyMeaning | 0..1 | code | grouped-by | is-a | part-of | classified-withrequired: codesystem-hierarchy-meaning |
compositional | 0..1 | boolean | If code system defines a compositional grammar |
versionNeeded | 0..1 | boolean | If definitions are not stable |
content | 1..1 | code | not-present | example | fragment | complete | supplementrequired: codesystem-content-mode |
supplements | 0..1 | canonical | Canonical URL of Code System this adds designations and properties to |
count | 0..1 | unsignedInt | Total concepts in the code system |
filter | 0..* | BackboneElement | Filter that can be used in a value set |
property | 0..* | BackboneElement | Additional information supplied about each concept |
concept | 0..* | BackboneElement | Concepts in the code system |