{
  "resourceType": "StructureDefinition",
  "id": "NamingSystem",
  "meta": {
    "lastUpdated": "2021-01-04T23:01:24.148+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Foundation.Terminology"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "anonymous"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".status = retired"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/template",
      "valueString": "CanonicalResource"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/NamingSystem",
  "version": "4.6.0",
  "name": "NamingSystem",
  "status": "draft",
  "date": "2021-01-04T23:01:24+00:00",
  "publisher": "Health Level Seven International (FHIR Infrastructure)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
        }
      ]
    }
  ],
  "description": "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.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "NamingSystem",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CanonicalResource",
  "derivation": "specialization",
  "differential": {
    "element": [
      {
        "id": "NamingSystem",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "0,0"
          }
        ],
        "path": "NamingSystem",
        "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.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "nsd-1",
            "severity": "error",
            "human": "Root systems cannot have uuid identifiers",
            "expression": "kind != 'root' or uniqueId.all(type != 'uuid')",
            "xpath": "not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')",
            "source": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
          },
          {
            "key": "cnl-0",
            "severity": "warning",
            "human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
            "expression": "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
            "xpath": "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')",
            "source": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "N/A"
          },
          {
            "identity": "w5",
            "map": "conformance.terminology"
          }
        ]
      },
      {
        "id": "NamingSystem.url",
        "path": "NamingSystem.url",
        "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 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.\n\nThe 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](resource.html#versions). \n\nIn 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](resource.html#meta) 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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.url"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "NamingSystem.version",
        "path": "NamingSystem.version",
        "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].",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.version"
          },
          {
            "identity": "w5",
            "map": "FiveWs.version"
          }
        ]
      },
      {
        "id": "NamingSystem.name",
        "path": "NamingSystem.name",
        "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "condition": [
          "cnl-0"
        ],
        "isSummary": true
      },
      {
        "id": "NamingSystem.title",
        "path": "NamingSystem.title",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "id": "NamingSystem.status",
        "path": "NamingSystem.status",
        "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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "PublicationStatus"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            }
          ],
          "strength": "required",
          "description": "The lifecycle status of an artifact.",
          "valueSet": "http://hl7.org/fhir/ValueSet/publication-status"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.status"
          },
          {
            "identity": "w5",
            "map": "FiveWs.status"
          }
        ]
      },
      {
        "id": "NamingSystem.kind",
        "path": "NamingSystem.kind",
        "short": "codesystem | identifier | root",
        "definition": "Indicates the purpose for the naming system - what kinds of things does it make unique?",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "NamingSystemType"
            }
          ],
          "strength": "required",
          "description": "Identifies the purpose of the naming system.",
          "valueSet": "http://hl7.org/fhir/ValueSet/namingsystem-type"
        },
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.class"
          }
        ]
      },
      {
        "id": "NamingSystem.date",
        "path": "NamingSystem.date",
        "short": "Date last changed",
        "definition": "The date  (and optionally time) when the naming system was published. 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": "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.",
        "alias": [
          "Revision Date"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.date"
          },
          {
            "identity": "w5",
            "map": "FiveWs.recorded"
          }
        ]
      },
      {
        "id": "NamingSystem.publisher",
        "path": "NamingSystem.publisher",
        "short": "Name of the publisher (organization or individual)",
        "definition": "The name of the organization or individual that published 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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.publisher"
          },
          {
            "identity": "w5",
            "map": "FiveWs.witness"
          }
        ]
      },
      {
        "id": "NamingSystem.contact",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "400,20"
          }
        ],
        "path": "NamingSystem.contact",
        "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactDetail"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.contact"
          }
        ]
      },
      {
        "id": "NamingSystem.responsible",
        "path": "NamingSystem.responsible",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.witness"
          }
        ]
      },
      {
        "id": "NamingSystem.type",
        "path": "NamingSystem.type",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "IdentifierType"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            }
          ],
          "strength": "extensible",
          "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
          "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type"
        }
      },
      {
        "id": "NamingSystem.description",
        "path": "NamingSystem.description",
        "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 why the naming system was built, 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).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.description"
          }
        ]
      },
      {
        "id": "NamingSystem.useContext",
        "path": "NamingSystem.useContext",
        "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "UsageContext"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.useContext"
          }
        ]
      },
      {
        "id": "NamingSystem.jurisdiction",
        "path": "NamingSystem.jurisdiction",
        "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "Jurisdiction"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            }
          ],
          "strength": "extensible",
          "description": "Countries and regions within which this artifact is targeted for use.",
          "valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.jurisdiction"
          }
        ]
      },
      {
        "id": "NamingSystem.usage",
        "path": "NamingSystem.usage",
        "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "NamingSystem.uniqueId",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "400,120"
          }
        ],
        "path": "NamingSystem.uniqueId",
        "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.",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ],
        "isSummary": true
      },
      {
        "id": "NamingSystem.uniqueId.type",
        "path": "NamingSystem.uniqueId.type",
        "short": "oid | uuid | uri | v2csmnemonic | other",
        "definition": "Identifies the unique identifier scheme used for this particular identifier.",
        "comment": "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.).  Other includes RUIDs from v3, standard v2 code name strings, etc.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "NamingSystemIdentifierType"
            }
          ],
          "strength": "required",
          "description": "Identifies the style of unique identifier used to identify a namespace.",
          "valueSet": "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type"
        }
      },
      {
        "id": "NamingSystem.uniqueId.value",
        "path": "NamingSystem.uniqueId.value",
        "short": "The unique identifier",
        "definition": "The string that should be sent over the wire to identify the code system or identifier system.",
        "comment": "If the value is a URI intended for use as FHIR system identifier, the URI should not contain \"\\\" or \"?\" or \",\" since this makes escaping very difficult.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "NamingSystem.uniqueId.preferred",
        "path": "NamingSystem.uniqueId.preferred",
        "short": "Is this the id that should be used for this type",
        "definition": "Indicates whether this identifier is the \"preferred\" identifier of this type.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "meaningWhenMissing": "If there are multiple ids, and one is labeled \"preferred\", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn",
        "constraint": [
          {
            "key": "nsd-2",
            "severity": "error",
            "human": "Can't have more than one preferred identifier for a type",
            "expression": "uniqueId.where(preferred = true).select(type).isDistinct()",
            "xpath": "not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))",
            "source": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
          }
        ]
      },
      {
        "id": "NamingSystem.uniqueId.comment",
        "path": "NamingSystem.uniqueId.comment",
        "short": "Notes about identifier usage",
        "definition": "Notes about the past or intended usage of this identifier.",
        "comment": "e.g. \"must be used in Germany\" or \"was initially published in error with this value\".",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "NamingSystem.uniqueId.period",
        "path": "NamingSystem.uniqueId.period",
        "short": "When is identifier valid?",
        "definition": "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system.  Outside of this window, the identifier might be non-deterministic.",
        "comment": "Within a registry, a given identifier should only be \"active\" for a single namespace at a time.  (Ideally, an identifier should only ever be associated with a single namespace across all time).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "NamingSystem.uniqueId.authoritative",
        "path": "NamingSystem.uniqueId.authoritative",
        "short": "Whether the identifier is authoritative",
        "definition": "Indicates whether this identifier ie endorsed by the official owner of the associated naming system.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "constraint": [
          {
            "key": "nsd-3",
            "severity": "error",
            "human": "Can't have more than one authoritative identifier for a type/period combination (only one authoritative identifier allowed at any given point of time)",
            "expression": "uniqueId.where(authoritative = true).select(type).isDistinct().select(period).isDistinct()",
            "xpath": "count(f:uniqueID)=count(distinct-values(f:uniqueID/f:period/@value)) or not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:authoritative/@value=true()])>1) then $type else ()))",
            "source": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
          }
        ]
      }
    ]
  }
}