This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CRMI Publishable NamingSystem

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

Usages:

• Examples for this Profile: SNOMEDCTExample

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
NamingSystem	C	1..1	NamingSystem	System of unique identification Constraints: nsd-0, nsd-1, nsd-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
extension:purpose	S	0..1	markdown	Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
extension:copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	S	0..1	date	When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
extension:lastReviewDate	S	0..1	date	Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
extension:effectivePeriod	S	0..1	Period	The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
extension:topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
extension:author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	S	0..*	(Complex)	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Slices for extension				Content/Rules for all slices
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
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
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]		1..1	RelatedArtifact	Value of extension
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	ΣC	1..1	string	Name for this naming system (computer friendly)
status	?!Σ	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	SΣ	1..1	dateTime	Date last changed
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
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.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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
NamingSystem		1..1	NamingSystem	System of unique identification
Slices for extension				Content/Rules for all slices
extension:identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
extension:purpose	S	0..1	markdown	Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
extension:copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	S	0..1	date	When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
extension:lastReviewDate	S	0..1	date	Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
extension:effectivePeriod	S	0..1	Period	The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
extension:topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
extension:author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	S	0..*	(Complex)	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Slices for extension				Content/Rules for all slices
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
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
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
date	S	1..1	dateTime	Date last changed
contact	S	0..*	ContactDetail	Contact details for the publisher
useContext	S	0..*	UsageContext	The context that the content is intended to support
jurisdiction	S	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
NamingSystem	C	1..1	NamingSystem	System of unique identification Constraints: nsd-0, nsd-1, nsd-2
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
extension:purpose	S	0..1	markdown	Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
extension:copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	S	0..1	date	When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
extension:lastReviewDate	S	0..1	date	Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
extension:effectivePeriod	S	0..1	Period	The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
extension:topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
extension:author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	S	0..*	(Complex)	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
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
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]		1..1	RelatedArtifact	Value of extension
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	ΣC	1..1	string	Name for this naming system (computer friendly)
status	?!Σ	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	SΣ	1..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
responsible		0..1	string	Who maintains system namespace?
type		0..1	CodeableConcept	e.g. driver, provider, patient, bank etc. Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
description		0..1	markdown	Natural language description of the naming system
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
usage		0..1	string	How/where is it used
uniqueId	Σ	1..*	BackboneElement	Unique identifiers used for system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
preferred		0..1	boolean	Is this the id that should be used for this type
comment		0..1	string	Notes about identifier usage
period		0..1	Period	When is identifier valid?
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
NamingSystem.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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: 1 element
Must-Support: 17 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/artifact-identifier
• http://hl7.org/fhir/StructureDefinition/artifact-purpose
• http://hl7.org/fhir/StructureDefinition/artifact-copyright
• http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
• http://hl7.org/fhir/StructureDefinition/resource-approvalDate
• http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
• http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
• http://hl7.org/fhir/StructureDefinition/artifact-topic
• http://hl7.org/fhir/StructureDefinition/artifact-author
• http://hl7.org/fhir/StructureDefinition/artifact-editor
• http://hl7.org/fhir/StructureDefinition/artifact-reviewer
• http://hl7.org/fhir/StructureDefinition/artifact-endorser
• http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
• http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
• http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
• http://hl7.org/fhir/StructureDefinition/cqf-artifactComment

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
NamingSystem	C	1..1	NamingSystem	System of unique identification Constraints: nsd-0, nsd-1, nsd-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
extension:purpose	S	0..1	markdown	Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
extension:copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	S	0..1	date	When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
extension:lastReviewDate	S	0..1	date	Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
extension:effectivePeriod	S	0..1	Period	The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
extension:topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
extension:author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	S	0..*	(Complex)	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Slices for extension				Content/Rules for all slices
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
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
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]		1..1	RelatedArtifact	Value of extension
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	ΣC	1..1	string	Name for this naming system (computer friendly)
status	?!Σ	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	SΣ	1..1	dateTime	Date last changed
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
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.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()

Differential View

This structure is derived from NamingSystem

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
NamingSystem		1..1	NamingSystem	System of unique identification
Slices for extension				Content/Rules for all slices
extension:identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
extension:purpose	S	0..1	markdown	Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
extension:copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	S	0..1	date	When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
extension:lastReviewDate	S	0..1	date	Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
extension:effectivePeriod	S	0..1	Period	The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
extension:topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
extension:author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	S	0..*	(Complex)	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Slices for extension				Content/Rules for all slices
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
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
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
date	S	1..1	dateTime	Date last changed
contact	S	0..*	ContactDetail	Contact details for the publisher
useContext	S	0..*	UsageContext	The context that the content is intended to support
jurisdiction	S	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
NamingSystem	C	1..1	NamingSystem	System of unique identification Constraints: nsd-0, nsd-1, nsd-2
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
extension:purpose	S	0..1	markdown	Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
extension:copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
extension:copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
extension:approvalDate	S	0..1	date	When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
extension:lastReviewDate	S	0..1	date	Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
extension:effectivePeriod	S	0..1	Period	The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
extension:topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
extension:author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
extension:editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
extension:reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
extension:endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
extension:relatedArtifact	S	0..*	(Complex)	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:publicationDate		0..1	date	Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
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
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
value[x]		1..1	RelatedArtifact	Value of extension
extension:artifactComment		0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	ΣC	1..1	string	Name for this naming system (computer friendly)
status	?!Σ	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	SΣ	1..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
responsible		0..1	string	Who maintains system namespace?
type		0..1	CodeableConcept	e.g. driver, provider, patient, bank etc. Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
description		0..1	markdown	Natural language description of the naming system
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for naming system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
usage		0..1	string	How/where is it used
uniqueId	Σ	1..*	BackboneElement	Unique identifiers used for system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
preferred		0..1	boolean	Is this the id that should be used for this type
comment		0..1	string	Notes about identifier usage
period		0..1	Period	When is identifier valid?
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
NamingSystem.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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: 1 element
Must-Support: 17 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/artifact-identifier
• http://hl7.org/fhir/StructureDefinition/artifact-purpose
• http://hl7.org/fhir/StructureDefinition/artifact-copyright
• http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
• http://hl7.org/fhir/StructureDefinition/resource-approvalDate
• http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
• http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
• http://hl7.org/fhir/StructureDefinition/artifact-topic
• http://hl7.org/fhir/StructureDefinition/artifact-author
• http://hl7.org/fhir/StructureDefinition/artifact-editor
• http://hl7.org/fhir/StructureDefinition/artifact-reviewer
• http://hl7.org/fhir/StructureDefinition/artifact-endorser
• http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
• http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
• http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
• http://hl7.org/fhir/StructureDefinition/cqf-artifactComment

Maturity: 1

Other representations of profile: CSV, Excel, Schematron