Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Publishable CodeSystem

Official URL: http://hl7.org/fhir/StructureDefinition/publishablecodesystem Version: 4.0.2
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: PublishableCodeSystem
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1129

Defines and enforces the minimum expectations for publication and distribution of a code system, typically as part of an artifact repository or implementation guide publication

​Original Source: hl7.org

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, pub-1
CodeSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CodeSystem.meta.Slices for extension Content/Rules for all slices
CodeSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
CodeSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CodeSystem.Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
CodeSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
CodeSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
CodeSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
CodeSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
CodeSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
CodeSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
CodeSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
CodeSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
CodeSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
CodeSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
CodeSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
CodeSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
CodeSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
CodeSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
CodeSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CodeSystem.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the code system (business identifier)
CodeSystem.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
CodeSystem.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
CodeSystem.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
CodeSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
CodeSystem.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
CodeSystem.purpose This element must be supported. 0..1 markdown Why this code system is defined
CodeSystem.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
CodeSystem.content This element is included in summaries. 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-0 warning 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}')
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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-4 error 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-5 error CodeSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CodeSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error CodeSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: pub-1
CodeSystem.meta
CodeSystem.meta.Slices for extension Content/Rules for all slices
CodeSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
CodeSystem.Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
CodeSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
CodeSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
CodeSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
CodeSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
CodeSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
CodeSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
CodeSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
CodeSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
CodeSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
CodeSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x]
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
CodeSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
CodeSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
CodeSystem.identifier This element must be supported. 0..* Identifier Additional identifier for the code system (business identifier)
CodeSystem.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
CodeSystem.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
CodeSystem.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
CodeSystem.purpose This element must be supported. 0..1 markdown Why this code system is defined
CodeSystem.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error CodeSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, pub-1
CodeSystem.id This element is included in summaries. 0..1 id Logical id of this artifact
CodeSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CodeSystem.meta.id 0..1 string Unique id for inter-element referencing
CodeSystem.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
CodeSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
CodeSystem.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
CodeSystem.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
CodeSystem.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
CodeSystem.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
CodeSystem.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
CodeSystem.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
CodeSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CodeSystem.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CodeSystem.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
CodeSystem.contained 0..* Resource Contained, inline Resources
CodeSystem.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
CodeSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
CodeSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
CodeSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
CodeSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
CodeSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
CodeSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
CodeSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
CodeSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
CodeSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
CodeSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
CodeSystem.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
CodeSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
CodeSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
CodeSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
CodeSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
CodeSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CodeSystem.url This element is included in summaries. 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
CodeSystem.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the code system (business identifier)
CodeSystem.version This element is included in summaries. 0..1 string Business version of the code system (Coding.version)
CodeSystem.name This element is included in summaries. C 0..1 string Name for this code system (computer friendly)
CodeSystem.title This element is included in summaries. 0..1 string Name for this code system (human friendly)
CodeSystem.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
CodeSystem.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
CodeSystem.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
CodeSystem.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
CodeSystem.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
CodeSystem.description 0..1 markdown Natural language description of the code system
CodeSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
CodeSystem.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
CodeSystem.purpose This element must be supported. 0..1 markdown Why this code system is defined
CodeSystem.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
CodeSystem.caseSensitive This element is included in summaries. 0..1 boolean If code comparison is case sensitive
CodeSystem.valueSet This element is included in summaries. 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
CodeSystem.hierarchyMeaning This element is included in summaries. 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
CodeSystem.compositional This element is included in summaries. 0..1 boolean If code system defines a compositional grammar
CodeSystem.versionNeeded This element is included in summaries. 0..1 boolean If definitions are not stable
CodeSystem.content This element is included in summaries. 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
CodeSystem.supplements This element is included in summaries. 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
CodeSystem.count This element is included in summaries. 0..1 unsignedInt Total concepts in the code system
CodeSystem.filter This element is included in summaries. 0..* BackboneElement Filter that can be used in a value set
CodeSystem.filter.id 0..1 string Unique id for inter-element referencing
CodeSystem.filter.extension 0..* Extension Additional content defined by implementations
CodeSystem.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.filter.code This element is included in summaries. 1..1 code Code that identifies the filter
CodeSystem.filter.description This element is included in summaries. 0..1 string How or why the filter is used
CodeSystem.filter.operator This element is included in summaries. 1..* code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
CodeSystem.filter.value This element is included in summaries. 1..1 string What to use for the value
CodeSystem.property This element is included in summaries. 0..* BackboneElement Additional information supplied about each concept
CodeSystem.property.id 0..1 string Unique id for inter-element referencing
CodeSystem.property.extension 0..* Extension Additional content defined by implementations
CodeSystem.property.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.property.code This element is included in summaries. 1..1 code Identifies the property on the concepts, and when referred to in operations
CodeSystem.property.uri This element is included in summaries. 0..1 uri Formal identifier for the property
CodeSystem.property.description This element is included in summaries. 0..1 string Why the property is defined, and/or what it conveys
CodeSystem.property.type This element is included in summaries. 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
CodeSystem.concept 0..* BackboneElement Concepts in the code system
CodeSystem.concept.id 0..1 string Unique id for inter-element referencing
CodeSystem.concept.extension 0..* Extension Additional content defined by implementations
CodeSystem.concept.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.concept.code 1..1 code Code that identifies concept
CodeSystem.concept.display 0..1 string Text to display to the user
CodeSystem.concept.definition 0..1 string Formal definition
CodeSystem.concept.designation 0..* BackboneElement Additional representations for the concept
CodeSystem.concept.designation.id 0..1 string Unique id for inter-element referencing
CodeSystem.concept.designation.extension 0..* Extension Additional content defined by implementations
CodeSystem.concept.designation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.concept.designation.language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CodeSystem.concept.designation.use 0..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.
CodeSystem.concept.designation.value 1..1 string The text value for this designation
CodeSystem.concept.property 0..* BackboneElement Property value for the concept
CodeSystem.concept.property.id 0..1 string Unique id for inter-element referencing
CodeSystem.concept.property.extension 0..* Extension Additional content defined by implementations
CodeSystem.concept.property.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.concept.property.code 1..1 code Reference to CodeSystem.property.code
CodeSystem.concept.property.value[x] 1..1 Value of the property for this concept
CodeSystem.concept.property.value[x].valueCode code
CodeSystem.concept.property.value[x].valueCoding Coding
CodeSystem.concept.property.value[x].valueString string
CodeSystem.concept.property.value[x].valueInteger integer
CodeSystem.concept.property.value[x].valueBoolean boolean
CodeSystem.concept.property.value[x].valueDateTime dateTime
CodeSystem.concept.property.value[x].valueDecimal decimal
CodeSystem.concept.concept 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
CodeSystem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CodeSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CodeSystem.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
CodeSystem.hierarchyMeaning Base required CodeSystemHierarchyMeaning 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.
CodeSystem.filter.operator Base required FilterOperator 📍4.0.1 FHIR Std.
CodeSystem.property.​type Base required PropertyType 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-0 warning 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}')
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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-4 error 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-5 error CodeSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CodeSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error CodeSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, pub-1
CodeSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CodeSystem.meta.Slices for extension Content/Rules for all slices
CodeSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
CodeSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CodeSystem.Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
CodeSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
CodeSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
CodeSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
CodeSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
CodeSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
CodeSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
CodeSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
CodeSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
CodeSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
CodeSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
CodeSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
CodeSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
CodeSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
CodeSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
CodeSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CodeSystem.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the code system (business identifier)
CodeSystem.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
CodeSystem.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
CodeSystem.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
CodeSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
CodeSystem.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
CodeSystem.purpose This element must be supported. 0..1 markdown Why this code system is defined
CodeSystem.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
CodeSystem.content This element is included in summaries. 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-0 warning 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}')
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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-4 error 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-5 error CodeSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CodeSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error CodeSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from CodeSystem

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: pub-1
CodeSystem.meta
CodeSystem.meta.Slices for extension Content/Rules for all slices
CodeSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
CodeSystem.Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
CodeSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
CodeSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
CodeSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
CodeSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
CodeSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
CodeSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
CodeSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
CodeSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
CodeSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
CodeSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x]
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
CodeSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
CodeSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
CodeSystem.identifier This element must be supported. 0..* Identifier Additional identifier for the code system (business identifier)
CodeSystem.date This element must be supported. 1..1 dateTime Date last changed
CodeSystem.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
CodeSystem.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
CodeSystem.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
CodeSystem.purpose This element must be supported. 0..1 markdown Why this code system is defined
CodeSystem.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error CodeSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CodeSystem C 1..1 CodeSystem Declares the existence of and describes a code system or code system supplement
Constraints: csd-0, csd-1, pub-1
CodeSystem.id This element is included in summaries. 0..1 id Logical id of this artifact
CodeSystem.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CodeSystem.meta.id 0..1 string Unique id for inter-element referencing
CodeSystem.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
CodeSystem.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
CodeSystem.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
CodeSystem.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
CodeSystem.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
CodeSystem.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
CodeSystem.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
CodeSystem.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
CodeSystem.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CodeSystem.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CodeSystem.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
CodeSystem.contained 0..* Resource Contained, inline Resources
CodeSystem.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
CodeSystem.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
CodeSystem.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
CodeSystem.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
CodeSystem.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
CodeSystem.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
CodeSystem.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
CodeSystem.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
CodeSystem.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
CodeSystem.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
CodeSystem.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
CodeSystem.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
CodeSystem.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
CodeSystem.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
CodeSystem.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
CodeSystem.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
CodeSystem.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
CodeSystem.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CodeSystem.url This element is included in summaries. 0..1 uri Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
CodeSystem.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the code system (business identifier)
CodeSystem.version This element is included in summaries. 0..1 string Business version of the code system (Coding.version)
CodeSystem.name This element is included in summaries. C 0..1 string Name for this code system (computer friendly)
CodeSystem.title This element is included in summaries. 0..1 string Name for this code system (human friendly)
CodeSystem.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
CodeSystem.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
CodeSystem.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
CodeSystem.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
CodeSystem.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
CodeSystem.description 0..1 markdown Natural language description of the code system
CodeSystem.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
CodeSystem.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
CodeSystem.purpose This element must be supported. 0..1 markdown Why this code system is defined
CodeSystem.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
CodeSystem.caseSensitive This element is included in summaries. 0..1 boolean If code comparison is case sensitive
CodeSystem.valueSet This element is included in summaries. 0..1 canonical(ValueSet) Canonical reference to the value set with entire code system
CodeSystem.hierarchyMeaning This element is included in summaries. 0..1 code grouped-by | is-a | part-of | classified-with
Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
CodeSystem.compositional This element is included in summaries. 0..1 boolean If code system defines a compositional grammar
CodeSystem.versionNeeded This element is included in summaries. 0..1 boolean If definitions are not stable
CodeSystem.content This element is included in summaries. 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
CodeSystem.supplements This element is included in summaries. 0..1 canonical(CodeSystem) Canonical URL of Code System this adds designations and properties to
CodeSystem.count This element is included in summaries. 0..1 unsignedInt Total concepts in the code system
CodeSystem.filter This element is included in summaries. 0..* BackboneElement Filter that can be used in a value set
CodeSystem.filter.id 0..1 string Unique id for inter-element referencing
CodeSystem.filter.extension 0..* Extension Additional content defined by implementations
CodeSystem.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.filter.code This element is included in summaries. 1..1 code Code that identifies the filter
CodeSystem.filter.description This element is included in summaries. 0..1 string How or why the filter is used
CodeSystem.filter.operator This element is included in summaries. 1..* code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
CodeSystem.filter.value This element is included in summaries. 1..1 string What to use for the value
CodeSystem.property This element is included in summaries. 0..* BackboneElement Additional information supplied about each concept
CodeSystem.property.id 0..1 string Unique id for inter-element referencing
CodeSystem.property.extension 0..* Extension Additional content defined by implementations
CodeSystem.property.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.property.code This element is included in summaries. 1..1 code Identifies the property on the concepts, and when referred to in operations
CodeSystem.property.uri This element is included in summaries. 0..1 uri Formal identifier for the property
CodeSystem.property.description This element is included in summaries. 0..1 string Why the property is defined, and/or what it conveys
CodeSystem.property.type This element is included in summaries. 1..1 code code | Coding | string | integer | boolean | dateTime | decimal
Binding: PropertyType (required): The type of a property value.
CodeSystem.concept 0..* BackboneElement Concepts in the code system
CodeSystem.concept.id 0..1 string Unique id for inter-element referencing
CodeSystem.concept.extension 0..* Extension Additional content defined by implementations
CodeSystem.concept.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.concept.code 1..1 code Code that identifies concept
CodeSystem.concept.display 0..1 string Text to display to the user
CodeSystem.concept.definition 0..1 string Formal definition
CodeSystem.concept.designation 0..* BackboneElement Additional representations for the concept
CodeSystem.concept.designation.id 0..1 string Unique id for inter-element referencing
CodeSystem.concept.designation.extension 0..* Extension Additional content defined by implementations
CodeSystem.concept.designation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.concept.designation.language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CodeSystem.concept.designation.use 0..1 Coding Details how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.
CodeSystem.concept.designation.value 1..1 string The text value for this designation
CodeSystem.concept.property 0..* BackboneElement Property value for the concept
CodeSystem.concept.property.id 0..1 string Unique id for inter-element referencing
CodeSystem.concept.property.extension 0..* Extension Additional content defined by implementations
CodeSystem.concept.property.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CodeSystem.concept.property.code 1..1 code Reference to CodeSystem.property.code
CodeSystem.concept.property.value[x] 1..1 Value of the property for this concept
CodeSystem.concept.property.value[x].valueCode code
CodeSystem.concept.property.value[x].valueCoding Coding
CodeSystem.concept.property.value[x].valueString string
CodeSystem.concept.property.value[x].valueInteger integer
CodeSystem.concept.property.value[x].valueBoolean boolean
CodeSystem.concept.property.value[x].valueDateTime dateTime
CodeSystem.concept.property.value[x].valueDecimal decimal
CodeSystem.concept.concept 0..* See concept (CodeSystem) Child Concepts (is-a/contains/categorizes)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CodeSystem.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
CodeSystem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CodeSystem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CodeSystem.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
CodeSystem.status Base required PublicationStatus 📍4.0.1 FHIR Std.
CodeSystem.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
CodeSystem.hierarchyMeaning Base required CodeSystemHierarchyMeaning 📍4.0.1 FHIR Std.
CodeSystem.content Base required CodeSystemContentMode 📍4.0.1 FHIR Std.
CodeSystem.filter.operator Base required FilterOperator 📍4.0.1 FHIR Std.
CodeSystem.property.​type Base required PropertyType 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
CodeSystem.concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
csd-0 warning 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}')
csd-1 error CodeSystem Within a code system definition, all the codes SHALL be unique concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2 error CodeSystem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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-4 error 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-5 error CodeSystem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CodeSystem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error CodeSystem If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

 

Other representations of profile: CSV, Excel, Schematron