Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot
Canonical Resource 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 1.0.0-snapshot 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
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablenamingsystem | Version: 1.0.0-snapshot | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRMIPublishableNamingSystem | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.38 | ||||
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
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NamingSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  NamingSystem |
1..1 | NamingSystem | System of unique identification | |
  identifier |
S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| purpose |
S | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| 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 |
| author |
S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor |
S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser |
S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
 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 |
|---|---|---|---|---|
| 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 |
| identifier |
S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| purpose |
S | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| 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 |
| author |
S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor |
S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser |
S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
 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 | ||||
| Path | Conformance | ValueSet | URI |
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1from the FHIR Standard | |
| NamingSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1from the FHIR Standard |
| 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() |
| 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 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| identifier |
S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | ||||
| purpose |
S | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | ||||
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| 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 | ||||
| author |
S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor |
S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer |
S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser |
S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| NamingSystem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1from the FHIR Standard | ||||
| NamingSystem.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| NamingSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1from the FHIR Standard |
| 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:
Maturity: 1
Differential View
This structure is derived from NamingSystem
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| NamingSystem |
1..1 | NamingSystem | System of unique identification | |
| identifier |
S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| purpose |
S | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| 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 |
| author |
S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor |
S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser |
S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| 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 | ||||
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 |
| identifier |
S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| purpose |
S | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| 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 |
| author |
S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor |
S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser |
S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1from the FHIR Standard | |
| NamingSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1from the FHIR Standard |
| 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
| 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 | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| identifier |
S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | ||||
| purpose |
S | 0..1 | markdown | Why this {{title}} is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | ||||
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| 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 | ||||
| author |
S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor |
S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer |
S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser |
S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| NamingSystem.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| NamingSystem.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| NamingSystem.kind | required | NamingSystemTypehttp://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1from the FHIR Standard | ||||
| NamingSystem.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| NamingSystem.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| NamingSystem.uniqueId.type | required | NamingSystemIdentifierTypehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1from the FHIR Standard |
| 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:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.0.0-snapshot based on FHIR 4.0.1. Generated 2024-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change