CRMI Shareable NamingSystem - Canonical Resource Management Infrastructure Implementation Guide v1.0.0

Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1 International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Shareable NamingSystem

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablenamingsystem		Version: 1.0.0
Standards status: Trial-use	Maturity Level: 1	Computable Name: CRMIShareableNamingSystem
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.53

Enforces the minimum information set for the naming system metadata required by HL7 and other organizations that share and publish naming systems

Usage:

Examples for this Resource Profile: SNOMEDCTShareable

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from NamingSystem

Name	Flags	Card.	Type	Description & Constraints
NamingSystem		1..1	NamingSystem	System of unique identification
Slices for extension				Content/Rules for all slices
knowledgeCapability	S	0..*	code	shareable \| computable \| publishable \| executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
url	S	1..1	uri	Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
version	S	1..1	string	Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata \| strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
title	S	1..1	string	Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title
experimental	S	0..1	boolean	For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
name	S	1..1	string	Name for this naming system (computer friendly)
status	S	1..1	code	draft \| active \| retired \| unknown
publisher	S	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the naming system
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
NamingSystem	C	1..1	NamingSystem	System of unique identification nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation nsd-1: Root systems cannot have uuid identifiers nsd-2: Can't have more than one preferred identifier for a type
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
knowledgeCapability	S	0..*	code	shareable \| computable \| publishable \| executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
url	S	1..1	uri	Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
version	S	1..1	string	Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata \| strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
title	S	1..1	string	Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title
experimental	S	0..1	boolean	For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	SΣC	1..1	string	Name for this naming system (computer friendly)
status	?!SΣ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
kind	Σ	1..1	code	codesystem \| identifier \| root Binding: NamingSystemType (required): Identifies the purpose of the naming system.
date	Σ	1..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the naming system
uniqueId	Σ	1..*	BackboneElement	Unique identifiers used for system
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	oid \| uuid \| uri \| other Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
value	Σ	1..1	string	The unique identifier
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
NamingSystem.status	required	PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status\|4.0.1` from the FHIR Standard
NamingSystem.kind	required	NamingSystemType `http://hl7.org/fhir/ValueSet/namingsystem-type\|4.0.1` from the FHIR Standard
NamingSystem.uniqueId.type	required	NamingSystemIdentifierType `http://hl7.org/fhir/ValueSet/namingsystem-identifier-type\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	NamingSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	NamingSystem	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	NamingSystem	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	NamingSystem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	NamingSystem	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()
nsd-0	warning	NamingSystem	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}')
nsd-1	error	NamingSystem	Root systems cannot have uuid identifiers : kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2	error	NamingSystem	Can't have more than one preferred identifier for a type : uniqueId.where(preferred = true).select(type).isDistinct()

Description & Constraints

NamingSystem

C

1..1

NamingSystem

System of unique identification
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

NamingSystem.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

NamingSystem.status

required

PublicationStatus

http://hl7.org/fhir/ValueSet/publication-status|4.0.1

from the FHIR Standard

NamingSystem.kind

required

NamingSystemType

http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1

from the FHIR Standard

NamingSystem.type

extensible

Identifier Type Codes

http://hl7.org/fhir/ValueSet/identifier-type

from the FHIR Standard

NamingSystem.jurisdiction

extensible

Jurisdiction ValueSet

http://hl7.org/fhir/ValueSet/jurisdiction

from the FHIR Standard

NamingSystem.uniqueId.type

required

NamingSystemIdentifierType

http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	NamingSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	NamingSystem	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	NamingSystem	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	NamingSystem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	NamingSystem	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()
nsd-0	warning	NamingSystem	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}')
nsd-1	error	NamingSystem	Root systems cannot have uuid identifiers : kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2	error	NamingSystem	Can't have more than one preferred identifier for a type : uniqueId.where(preferred = true).select(type).isDistinct()

This structure is derived from NamingSystem

Summary

Mandatory: 4 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Maturity: 1

Differential View

This structure is derived from NamingSystem

Name	Flags	Card.	Type	Description & Constraints
NamingSystem		1..1	NamingSystem	System of unique identification
Slices for extension				Content/Rules for all slices
knowledgeCapability	S	0..*	code	shareable \| computable \| publishable \| executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
url	S	1..1	uri	Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
version	S	1..1	string	Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata \| strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
title	S	1..1	string	Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title
experimental	S	0..1	boolean	For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
name	S	1..1	string	Name for this naming system (computer friendly)
status	S	1..1	code	draft \| active \| retired \| unknown
publisher	S	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the naming system
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
NamingSystem	C	1..1	NamingSystem	System of unique identification nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation nsd-1: Root systems cannot have uuid identifiers nsd-2: Can't have more than one preferred identifier for a type
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		3..*	Extension	Extension Slice: Unordered, Open by value:url
knowledgeCapability	S	0..*	code	shareable \| computable \| publishable \| executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
url	S	1..1	uri	Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
version	S	1..1	string	Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata \| strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
title	S	1..1	string	Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title
experimental	S	0..1	boolean	For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	SΣC	1..1	string	Name for this naming system (computer friendly)
status	?!SΣ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
kind	Σ	1..1	code	codesystem \| identifier \| root Binding: NamingSystemType (required): Identifies the purpose of the naming system.
date	Σ	1..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the naming system
uniqueId	Σ	1..*	BackboneElement	Unique identifiers used for system
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	oid \| uuid \| uri \| other Binding: NamingSystemIdentifierType (required): Identifies the style of unique identifier used to identify a namespace.
value	Σ	1..1	string	The unique identifier
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
NamingSystem.status	required	PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status\|4.0.1` from the FHIR Standard
NamingSystem.kind	required	NamingSystemType `http://hl7.org/fhir/ValueSet/namingsystem-type\|4.0.1` from the FHIR Standard
NamingSystem.uniqueId.type	required	NamingSystemIdentifierType `http://hl7.org/fhir/ValueSet/namingsystem-identifier-type\|4.0.1` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	NamingSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	NamingSystem	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	NamingSystem	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	NamingSystem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	NamingSystem	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()
nsd-0	warning	NamingSystem	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}')
nsd-1	error	NamingSystem	Root systems cannot have uuid identifiers : kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2	error	NamingSystem	Can't have more than one preferred identifier for a type : uniqueId.where(preferred = true).select(type).isDistinct()

Snapshot View

Description & Constraints

NamingSystem

C

1..1

NamingSystem

System of unique identification
nsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
nsd-1: Root systems cannot have uuid identifiers
nsd-2: Can't have more than one preferred identifier for a type

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

NamingSystem.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

NamingSystem.status

required

PublicationStatus

http://hl7.org/fhir/ValueSet/publication-status|4.0.1

from the FHIR Standard

NamingSystem.kind

required

NamingSystemType

http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1

from the FHIR Standard

NamingSystem.type

extensible

Identifier Type Codes

http://hl7.org/fhir/ValueSet/identifier-type

from the FHIR Standard

NamingSystem.jurisdiction

extensible

Jurisdiction ValueSet

http://hl7.org/fhir/ValueSet/jurisdiction

from the FHIR Standard

NamingSystem.uniqueId.type

required

NamingSystemIdentifierType

http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	NamingSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	NamingSystem	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	NamingSystem	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	NamingSystem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	NamingSystem	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()
nsd-0	warning	NamingSystem	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}')
nsd-1	error	NamingSystem	Root systems cannot have uuid identifiers : kind != 'root' or uniqueId.all(type != 'uuid')
nsd-2	error	NamingSystem	Can't have more than one preferred identifier for a type : uniqueId.where(preferred = true).select(type).isDistinct()

This structure is derived from NamingSystem

Summary

Mandatory: 4 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.0.0 based on FHIR 4.0.1. Generated 2024-05-31
Links: Table of Contents | QA Report | Version History | | Propose a change