FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

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

D.4.1 StructureDefinition: cpg-codesystem

Examples:

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

D.4.1.1 Formal Views of Profile Content

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I1..1Declares the existence of and describes a code system or code system supplement
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-approvalDate SI0..1dateWhen resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
... codesystem-effectiveDate SI0..1dateWhen the value set version becomes Active and is available for use
URL: http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate
... codesystem-expirationDate SI0..1dateWhen the value set version should no longer be used
URL: http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate
... resource-lastReviewDate SI0..1dateLast review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
... codesystem-author SI0..*stringUser or Org actually involved in creating the value set content
URL: http://hl7.org/fhir/StructureDefinition/codesystem-author
... codesystem-keyWord SI0..*stringDescriptors and key terms for search
URL: http://hl7.org/fhir/StructureDefinition/codesystem-keyWord
... codesystem-sourceReference SI0..*uriWhere did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier SΣ0..*IdentifierAdditional identifier for the code system (business identifier)
... version SΣ1..1stringBusiness version of the code system (Coding.version)
... name SΣI1..1stringName for this code system (computer friendly)
... title SΣ1..1stringName for this code system (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ1..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the code system
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this code system is defined
... copyright S0..1markdownUse and/or publishing restrictions
... caseSensitive SΣ1..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required)
... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content Σ1..1codenot-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required)
... supplements Σ0..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter ΣI0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow or why the filter is used
.... operator Σ1..*codeOperators that can be used with filter
Binding: FilterOperator (required)
.... value Σ1..1stringWhat to use for the value
... property ΣI0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required)
... concept I1..*BackboneElementConcepts in the code system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation I0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
..... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible)
..... value 1..1stringThe text value for this designation
.... property I0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*Unknown reference to #CodeSystem.concept
Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeSystem I1..1Declares the existence of and describes a code system or code system supplement
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-approvalDate SI0..1dateWhen resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
... codesystem-effectiveDate SI0..1dateWhen the value set version becomes Active and is available for use
URL: http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate
... codesystem-expirationDate SI0..1dateWhen the value set version should no longer be used
URL: http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate
... resource-lastReviewDate SI0..1dateLast review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
... codesystem-author SI0..*stringUser or Org actually involved in creating the value set content
URL: http://hl7.org/fhir/StructureDefinition/codesystem-author
... codesystem-keyWord SI0..*stringDescriptors and key terms for search
URL: http://hl7.org/fhir/StructureDefinition/codesystem-keyWord
... codesystem-sourceReference SI0..*uriWhere did this content come from
URL: http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
... identifier SΣ0..*IdentifierAdditional identifier for the code system (business identifier)
... version SΣ1..1stringBusiness version of the code system (Coding.version)
... name SΣI1..1stringName for this code system (computer friendly)
... title SΣ1..1stringName for this code system (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ1..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the code system
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this code system is defined
... copyright S0..1markdownUse and/or publishing restrictions
... caseSensitive SΣ1..1booleanIf code comparison is case sensitive
... valueSet Σ0..1canonical(ValueSet)Canonical reference to the value set with entire code system
... hierarchyMeaning Σ0..1codegrouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required)
... compositional Σ0..1booleanIf code system defines a compositional grammar
... versionNeeded Σ0..1booleanIf definitions are not stable
... content Σ1..1codenot-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required)
... supplements Σ0..1canonical(CodeSystem)Canonical URL of Code System this adds designations and properties to
... count Σ0..1unsignedIntTotal concepts in the code system
... filter ΣI0..*BackboneElementFilter that can be used in a value set
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeCode that identifies the filter
.... description Σ0..1stringHow or why the filter is used
.... operator Σ1..*codeOperators that can be used with filter
Binding: FilterOperator (required)
.... value Σ1..1stringWhat to use for the value
... property ΣI0..*BackboneElementAdditional information supplied about each concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codeIdentifies the property on the concepts, and when referred to in operations
.... uri Σ0..1uriFormal identifier for the property
.... description Σ0..1stringWhy the property is defined, and/or what it conveys
.... type Σ1..1codecode | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required)
... concept I1..*BackboneElementConcepts in the code system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1codeCode that identifies concept
.... display 0..1stringText to display to the user
.... definition 0..1stringFormal definition
.... designation I0..*BackboneElementAdditional representations for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
..... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible)
..... value 1..1stringThe text value for this designation
.... property I0..*BackboneElementProperty value for the concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeReference to CodeSystem.property.code
..... value[x] 1..1Value of the property for this concept
...... valueCodecode
...... valueCodingCoding
...... valueStringstring
...... valueIntegerinteger
...... valueBooleanboolean
...... valueDateTimedateTime
...... valueDecimaldecimal
.... concept 0..*Unknown reference to #CodeSystem.concept
Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
CodeSystem.languagepreferredCommonLanguages
Max Binding: AllLanguages
CodeSystem.statusrequiredPublicationStatus
CodeSystem.jurisdictionextensibleJurisdiction ValueSet
CodeSystem.hierarchyMeaningrequiredCodeSystemHierarchyMeaning
CodeSystem.contentrequiredCodeSystemContentMode
CodeSystem.filter.operatorrequiredFilterOperator
CodeSystem.property.typerequiredPropertyType
CodeSystem.concept.designation.languagepreferredCommonLanguages
Max Binding: AllLanguages
CodeSystem.concept.designation.useextensibleDesignationUse

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CodeSystemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4CodeSystemIf 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-3CodeSystemIf 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-6CodeSystemA resource should have narrative for robust management
: text.div.exists()
dom-5CodeSystemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
csd-1CodeSystemWithin a code system definition, all the codes SHALL be unique
: concept.code.combine($this.descendants().concept.code).isDistinct()
csd-0CodeSystemName 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-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CodeSystem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CodeSystem.filterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CodeSystem.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CodeSystem.conceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CodeSystem.concept.designationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CodeSystem.concept.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())