Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
NamingSystem | TU | DomainResource | System of unique identification
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Root systems cannot have uuid identifiers + Rule: Can't have more than one preferred identifier for a type + Rule: Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource |
|
url | Σ C | 0..1 | uri | Canonical identifier for this naming system, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the naming system (business identifier)
|
version | Σ | 0..1 | string | Business version of the naming system
|
versionAlgorithm[x] | Σ | 0..1 | How to compare versions
Binding: Version Algorithm ( Extensible) |
|
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ C | 1..1 | string | Name for this naming system (computer friendly)
|
title | Σ T | 0..1 | string | Title for this naming system (human friendly)
|
status | ?! Σ | 1..1 | code | draft | active | retired | unknown
Binding: PublicationStatus ( Required) |
kind | Σ C | 1..1 | code | codesystem | identifier | root
Binding: Naming System Type ( Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
|
date | Σ | 1..1 | dateTime | Date last changed
|
publisher | Σ T | 0..1 | string | Name of the publisher/steward (organization or individual)
|
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
|
responsible | T | 0..1 | string | Who maintains system namespace?
|
type | 0..1 | CodeableConcept | e.g. driver, provider, patient, bank etc
Binding: Naming System Identifier System Type ( Preferred) |
|
description | T | 0..1 | markdown | Natural language description of the naming system
|
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
|
jurisdiction | Σ XD | 0..* | CodeableConcept | Intended jurisdiction for naming system (if applicable)
Binding: Jurisdiction ValueSet ( Extensible) |
purpose | T | 0..1 | markdown | Why this naming system is defined
|
copyright | T | 0..1 | markdown | Use and/or publishing restrictions
|
copyrightLabel | T | 0..1 | string | Copyright holder and year(s)
|
approvalDate | 0..1 | date | When the NamingSystem was approved by publisher
|
|
lastReviewDate | 0..1 | date | When the NamingSystem was last reviewed by the publisher
|
|
effectivePeriod | Σ | 0..1 | Period | When the NamingSystem is expected to be used
|
topic | XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( Example) |
author | 0..* | ContactDetail | Who authored the CodeSystem
|
|
editor | 0..* | ContactDetail | Who edited the NamingSystem
|
|
reviewer | 0..* | ContactDetail | Who reviewed the NamingSystem
|
|
endorser | 0..* | ContactDetail | Who endorsed the NamingSystem
|
|
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc
|
|
usage | T | 0..1 | string | How/where is it used
|
uniqueId | Σ C | 1..* | BackboneElement | Unique identifiers used for system
|
type | Σ C | 1..1 | code | oid | uuid | uri | iri-stem | v2csmnemonic | other
Binding: Naming System Identifier Type ( Required) |
value | Σ | 1..1 | string | The unique identifier
|
preferred | C | 0..1 | boolean | Is this the id that should be used for this type
|
comment | 0..1 | string | Notes about identifier usage
|
|
period | C | 0..1 | Period | When is identifier valid?
|
authoritative | C | 0..1 | boolean | Whether the identifier is authoritative
|
Documentation for this format |