This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Example | id | Format | |
---|---|---|---|
Common persona code system | cpg-common-persona | XML | JSON |
Common process code system | cpg-common-persona | XML | JSON |
Guidance indicator code system | cpg-common-persona | XML | JSON |
Recommendation direction code system | cpg-common-persona | XML | JSON |
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-codesystem
Profile of CodeSystem for use with CPG Implementation Guide
This profile builds on Shareable CodeSystem.
This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 3 elements
Must-Support: 23 elements
Extensions
This structure refers to these extensions:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | I | 1..1 | Declares the existence of and describes a code system or code system supplement | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | 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 content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-approvalDate | SI | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate |
codesystem-effectiveDate | SI | 0..1 | date | When the value set version becomes Active and is available for use URL: http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate |
codesystem-expirationDate | SI | 0..1 | date | When the value set version should no longer be used URL: http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate |
resource-lastReviewDate | SI | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate |
codesystem-author | SI | 0..* | string | User or Org actually involved in creating the value set content URL: http://hl7.org/fhir/StructureDefinition/codesystem-author |
codesystem-keyWord | SI | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/codesystem-keyWord |
codesystem-sourceReference | SI | 0..* | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the code system (business identifier) |
version | SΣ | 1..1 | string | Business version of the code system (Coding.version) |
name | SΣI | 1..1 | string | Name for this code system (computer friendly) |
title | SΣ | 1..1 | string | Name for this code system (human friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | S | 1..1 | markdown | Natural language description of the code system |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | S | 0..1 | markdown | Why this code system is defined |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
caseSensitive | SΣ | 1..1 | boolean | If code comparison is case sensitive |
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system |
hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required) |
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 | supplement Binding: CodeSystemContentMode (required) |
supplements | Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to |
count | Σ | 0..1 | unsignedInt | Total concepts in the code system |
filter | ΣI | 0..* | BackboneElement | Filter that can be used in a value set |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | Code that identifies the filter |
description | Σ | 0..1 | string | How or why the filter is used |
operator | Σ | 1..* | code | Operators that can be used with filter Binding: FilterOperator (required) |
value | Σ | 1..1 | string | What to use for the value |
property | ΣI | 0..* | BackboneElement | Additional information supplied about each concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | Σ | 0..1 | uri | Formal identifier for the property |
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys |
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required) |
concept | I | 1..* | BackboneElement | Concepts in the code system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Code that identifies concept | |
display | 0..1 | string | Text to display to the user | |
definition | 0..1 | string | Formal definition | |
designation | I | 0..* | BackboneElement | Additional representations for the concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
use | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible) | |
value | 1..1 | string | The text value for this designation | |
property | I | 0..* | BackboneElement | Property value for the concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Reference to CodeSystem.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
concept | 0..* | Unknown reference to #CodeSystem.concept Child Concepts (is-a/contains/categorizes) | ||
Documentation for this format |
Summary
Mandatory: 3 elements
Must-Support: 23 elements
Extensions
This structure refers to these extensions:
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CodeSystem | I | 1..1 | Declares the existence of and describes a code system or code system supplement | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | 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 content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-approvalDate | SI | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate |
codesystem-effectiveDate | SI | 0..1 | date | When the value set version becomes Active and is available for use URL: http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate |
codesystem-expirationDate | SI | 0..1 | date | When the value set version should no longer be used URL: http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate |
resource-lastReviewDate | SI | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate |
codesystem-author | SI | 0..* | string | User or Org actually involved in creating the value set content URL: http://hl7.org/fhir/StructureDefinition/codesystem-author |
codesystem-keyWord | SI | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/codesystem-keyWord |
codesystem-sourceReference | SI | 0..* | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the code system (business identifier) |
version | SΣ | 1..1 | string | Business version of the code system (Coding.version) |
name | SΣI | 1..1 | string | Name for this code system (computer friendly) |
title | SΣ | 1..1 | string | Name for this code system (human friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | S | 1..1 | markdown | Natural language description of the code system |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | S | 0..1 | markdown | Why this code system is defined |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
caseSensitive | SΣ | 1..1 | boolean | If code comparison is case sensitive |
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system |
hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required) |
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 | supplement Binding: CodeSystemContentMode (required) |
supplements | Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to |
count | Σ | 0..1 | unsignedInt | Total concepts in the code system |
filter | ΣI | 0..* | BackboneElement | Filter that can be used in a value set |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | Code that identifies the filter |
description | Σ | 0..1 | string | How or why the filter is used |
operator | Σ | 1..* | code | Operators that can be used with filter Binding: FilterOperator (required) |
value | Σ | 1..1 | string | What to use for the value |
property | ΣI | 0..* | BackboneElement | Additional information supplied about each concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations |
uri | Σ | 0..1 | uri | Formal identifier for the property |
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys |
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required) |
concept | I | 1..* | BackboneElement | Concepts in the code system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Code that identifies concept | |
display | 0..1 | string | Text to display to the user | |
definition | 0..1 | string | Formal definition | |
designation | I | 0..* | BackboneElement | Additional representations for the concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
use | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible) | |
value | 1..1 | string | The text value for this designation | |
property | I | 0..* | BackboneElement | Property value for the concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Reference to CodeSystem.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
concept | 0..* | Unknown reference to #CodeSystem.concept Child Concepts (is-a/contains/categorizes) | ||
Documentation for this format |
Path | Conformance | ValueSet |
CodeSystem.language | preferred | CommonLanguages Max Binding: AllLanguages |
CodeSystem.status | required | PublicationStatus |
CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet |
CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning |
CodeSystem.content | required | CodeSystemContentMode |
CodeSystem.filter.operator | required | FilterOperator |
CodeSystem.property.type | required | PropertyType |
CodeSystem.concept.designation.language | preferred | CommonLanguages Max Binding: AllLanguages |
CodeSystem.concept.designation.use | extensible | DesignationUse |
Id | Path | Details | Requirements |
dom-2 | CodeSystem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | CodeSystem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-6 | CodeSystem | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | CodeSystem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
csd-1 | CodeSystem | Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct() | |
csd-0 | CodeSystem | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | CodeSystem.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | CodeSystem.filter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CodeSystem.property | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CodeSystem.concept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CodeSystem.concept.designation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | CodeSystem.concept.property | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |