Data Model Libraries
    Preparing search index...

    NamingSystem Class

    A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

    FHIR Specification

    • Short: System of unique identification
    • Definition: A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getKindEnumType setKindEnumType hasKindEnumType getKindElement setKindElement hasKindElement getKind setKind hasKind getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getResponsibleElement setResponsibleElement hasResponsibleElement getResponsible setResponsible hasResponsible getType setType hasType getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getTopic setTopic addTopic hasTopic getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getUsageElement setUsageElement hasUsageElement getUsage setUsage hasUsage getUniqueId setUniqueId addUniqueId hasUniqueId fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initUseContext initJurisdiction initTopic initAuthor initEditor initReviewer initEndorser initRelatedArtifact initUniqueId

    Constructors

    Properties

    url?: UriType

    NamingSystem.url Element

    FHIR Specification

    • Short: Canonical identifier for this naming system, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this naming system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the naming system to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    NamingSystem.identifier Element

    FHIR Specification

    • Short: Additional identifier for the naming system (business identifier)
    • Definition: A formal identifier that is used to identify this naming system when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this naming system outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the naming system.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    NamingSystem.version Element

    FHIR Specification

    • Short: Business version of the naming system
    • Definition: The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Comment: There may be different naming system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the naming system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    NamingSystem.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('NamingSystem.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which NamingSystem is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name: null | StringType

    FHIR Specification

    • Short: Name for this naming system (computer friendly)
    • Definition: A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The"symbolic name" for an OID would be captured as an extension.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    NamingSystem.title Element

    FHIR Specification

    • Short: Title for this naming system (human friendly)
    • Definition: A short, descriptive, user-friendly title for the naming system.
    • Comment: This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    status: null | EnumCodeType

    NamingSystem.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this naming system. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of naming systems that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    namingsystemTypeEnum: NamingsystemTypeEnum

    FHIR CodeSystem: NamingsystemType

    kind: null | EnumCodeType

    NamingSystem.kind Element

    FHIR Specification

    • Short: codesystem | identifier | root
    • Definition: Indicates the purpose for the naming system - what kinds of things does it make unique?
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: NamingsystemTypeEnum

    experimental?: BooleanType

    NamingSystem.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: A Boolean value to indicate that this naming system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • Comment: Allows filtering of naming systems that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level naming system.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date: null | DateTimeType

    NamingSystem.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the naming system was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.
    • Comment: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    NamingSystem.publisher Element

    FHIR Specification

    • Short: Name of the publisher/steward (organization or individual)
    • Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the naming system.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the naming system. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    NamingSystem.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    responsible?: StringType

    NamingSystem.responsible Element

    FHIR Specification

    • Short: Who maintains system namespace?
    • Definition: The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
    • Comment: This is the primary organization. Responsibility for some aspects of a namespace may be delegated.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    NamingSystem.type Element

    FHIR Specification

    • Short: e.g. driver, provider, patient, bank etc
    • Definition: Categorizes a naming system for easier search by grouping related naming systems.
    • Comment: This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    NamingSystem.description Element

    FHIR Specification

    • Short: Natural language description of the naming system
    • Definition: A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
    • Comment: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    NamingSystem.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    NamingSystem.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for naming system (if applicable)
    • Definition: A legal or geographic region in which the naming system is intended to be used.
    • Comment: It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    NamingSystem.purpose Element

    FHIR Specification

    • Short: Why this naming system is defined
    • Definition: Explanation of why this naming system is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    NamingSystem.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the naming system and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    NamingSystem.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
    • Comment: The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    NamingSystem.approvalDate Element

    FHIR Specification

    • Short: When the NamingSystem was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    NamingSystem.lastReviewDate Element

    FHIR Specification

    • Short: When the NamingSystem was last reviewed by the publisher
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    NamingSystem.effectivePeriod Element

    FHIR Specification

    • Short: When the NamingSystem is expected to be used
    • Definition: The period during which the NamingSystem content was or is planned to be in active use.
    • Comment: The effective period for a NamingSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a NamingSystem intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the NamingSystem are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    topic?: CodeableConcept[]

    NamingSystem.topic Element

    FHIR Specification

    • Short: E.g. Education, Treatment, Assessment, etc
    • Definition: Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searching.
    • Comment: DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
    • Requirements: Repositories must be able to determine how to categorize the NamingSystem so that it can be found by topical and keyword searches.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: ContactDetail[]

    NamingSystem.author Element

    FHIR Specification

    • Short: Who authored the CodeSystem
    • Definition: An individiual or organization primarily involved in the creation and maintenance of the NamingSystem.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    editor?: ContactDetail[]

    NamingSystem.editor Element

    FHIR Specification

    • Short: Who edited the NamingSystem
    • Definition: An individual or organization primarily responsible for internal coherence of the NamingSystem.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    NamingSystem.reviewer Element

    FHIR Specification

    • Short: Who reviewed the NamingSystem
    • Definition: An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    NamingSystem.endorser Element

    FHIR Specification

    • Short: Who endorsed the NamingSystem
    • Definition: An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    NamingSystem.relatedArtifact Element

    FHIR Specification

    • Short: Additional documentation, citations, etc
    • Definition: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
    • Comment: Each related artifact is either an attachment, or a reference to another resource, but not both.
    • Requirements: A NamingSystem must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    usage?: StringType

    NamingSystem.usage Element

    FHIR Specification

    • Short: How/where is it used
    • Definition: Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    NamingSystem.uniqueId Element

    FHIR Specification

    • Short: Unique identifiers used for system
    • Definition: Indicates how the system may be identified when referenced in electronic exchange.
    • Comment: Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided NamingSystem JSON to instantiate the NamingSystem data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR NamingSystem

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to NamingSystem

      Returns undefined | NamingSystem

      NamingSystem data model or undefined for NamingSystem

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise