<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="NamingSystem" />
  <meta>
    <lastUpdated value="2021-01-05T10:01:24.148+11:00" />
  </meta>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category">
    <valueString value="Foundation.Terminology" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category">
    <valueCode value="anonymous" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir" />
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status">
    <valueCode value=".status = retired" />
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/template">
    <valueString value="CanonicalResource" />
  </extension>
  <url value="http://hl7.org/fhir/StructureDefinition/NamingSystem" />
  <version value="4.6.0" />
  <name value="NamingSystem" />
  <status value="draft" />
  <date value="2021-01-05T10:01:24+11:00" />
  <publisher value="Health Level Seven International (FHIR Infrastructure)" />
  <contact>
    <telecom>
      <system value="url" />
      <value value="http://hl7.org/fhir" />
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url" />
      <value value="http://www.hl7.org/Special/committees/fiwg/index.cfm" />
    </telecom>
  </contact>
  <description value="A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc.  Represents a &quot;System&quot; used within the Identifier and Coding data types." />
  <fhirVersion value="4.6.0" />
  <mapping>
    <identity value="v2" />
    <uri value="http://hl7.org/v2" />
    <name value="HL7 v2 Mapping" />
  </mapping>
  <mapping>
    <identity value="rim" />
    <uri value="http://hl7.org/v3" />
    <name value="RIM Mapping" />
  </mapping>
  <mapping>
    <identity value="w5" />
    <uri value="http://hl7.org/fhir/fivews" />
    <name value="FiveWs Pattern Mapping" />
  </mapping>
  <mapping>
    <identity value="workflow" />
    <uri value="http://hl7.org/fhir/workflow" />
    <name value="Workflow Pattern" />
  </mapping>
  <kind value="resource" />
  <abstract value="false" />
  <type value="NamingSystem" />
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CanonicalResource" />
  <derivation value="specialization" />
  <differential>
    <element id="NamingSystem">
      <extension url="http://hl7.org/fhir/build/StructureDefinition/svg">
        <valueCode value="0,0" />
      </extension>
      <path value="NamingSystem" />
      <short value="System of unique identification" />
      <definition value="A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc.  Represents a &quot;System&quot; used within the Identifier and Coding data types." />
      <min value="0" />
      <max value="*" />
      <constraint>
        <key value="nsd-1" />
        <severity value="error" />
        <human value="Root systems cannot have uuid identifiers" />
        <expression value="kind != 'root' or uniqueId.all(type != 'uuid')" />
        <xpath value="not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')" />
        <source value="http://hl7.org/fhir/StructureDefinition/NamingSystem" />
      </constraint>
      <constraint>
        <key value="cnl-0" />
        <severity value="warning" />
        <human value="Name should be usable as an identifier for the module by machine processing applications such as code generation" />
        <expression value="name.matches('[A-Z]([A-Za-z0-9_]){0,254}')" />
        <xpath value="not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')" />
        <source value="http://hl7.org/fhir/StructureDefinition/NamingSystem" />
      </constraint>
      <mapping>
        <identity value="v2" />
        <map value="N/A" />
      </mapping>
      <mapping>
        <identity value="rim" />
        <map value="N/A" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="conformance.terminology" />
      </mapping>
    </element>
    <element id="NamingSystem.url">
      <path value="NamingSystem.url" />
      <short value="Canonical identifier for this naming system, represented as a URI (globally unique)" />
      <definition value="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 value="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.&#xA;&#xA;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](resource.html#versions). &#xA;&#xA;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](resource.html#meta) element to indicate where the current master source of the resource can be found." />
      <requirements value="Allows the naming system to be referenced by a single globally unique identifier." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="uri" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="workflow" />
        <map value="Definition.url" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.identifier" />
      </mapping>
    </element>
    <element id="NamingSystem.version">
      <path value="NamingSystem.version" />
      <short value="Business version of the naming system" />
      <definition value="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 value="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 value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="workflow" />
        <map value="Definition.version" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.version" />
      </mapping>
    </element>
    <element id="NamingSystem.name">
      <path value="NamingSystem.name" />
      <short value="Name for this naming system (computer friendly)" />
      <definition value="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 value="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&quot;symbolic name&quot; for an OID would be captured as an extension." />
      <requirements value="Support human navigation and code generation." />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <condition value="cnl-0" />
      <isSummary value="true" />
    </element>
    <element id="NamingSystem.title">
      <path value="NamingSystem.title" />
      <short value="Title for this naming system (human friendly)" />
      <definition value="A short, descriptive, user-friendly title for the naming system." />
      <comment value="This title does not need to be machine-processing friendly and may contain punctuation, white-space, etc." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <isSummary value="true" />
    </element>
    <element id="NamingSystem.status">
      <path value="NamingSystem.status" />
      <short value="draft | active | retired | unknown" />
      <definition value="The status of this naming system. Enables tracking the life-cycle of the content." />
      <comment value="Allows filtering of naming systems that are appropriate for use versus not." />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="code" />
      </type>
      <isModifier value="true" />
      <isModifierReason value="This is labeled as &quot;Is Modifier&quot; because applications should not use a retired {{title}} without due consideration" />
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="PublicationStatus" />
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true" />
        </extension>
        <strength value="required" />
        <description value="The lifecycle status of an artifact." />
        <valueSet value="http://hl7.org/fhir/ValueSet/publication-status" />
      </binding>
      <mapping>
        <identity value="workflow" />
        <map value="Definition.status" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.status" />
      </mapping>
    </element>
    <element id="NamingSystem.kind">
      <path value="NamingSystem.kind" />
      <short value="codesystem | identifier | root" />
      <definition value="Indicates the purpose for the naming system - what kinds of things does it make unique?" />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="code" />
      </type>
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="NamingSystemType" />
        </extension>
        <strength value="required" />
        <description value="Identifies the purpose of the naming system." />
        <valueSet value="http://hl7.org/fhir/ValueSet/namingsystem-type" />
      </binding>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.class" />
      </mapping>
    </element>
    <element id="NamingSystem.date">
      <path value="NamingSystem.date" />
      <short value="Date last changed" />
      <definition value="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 value="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 value="Revision Date" />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="dateTime" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="workflow" />
        <map value="Definition.date" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.recorded" />
      </mapping>
    </element>
    <element id="NamingSystem.publisher">
      <path value="NamingSystem.publisher" />
      <short value="Name of the publisher (organization or individual)" />
      <definition value="The name of the organization or individual that published the naming system." />
      <comment value="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 value="Helps establish the &quot;authority/credibility&quot; of the naming system.  May also allow for contact." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="workflow" />
        <map value="Definition.publisher" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.witness" />
      </mapping>
    </element>
    <element id="NamingSystem.contact">
      <extension url="http://hl7.org/fhir/build/StructureDefinition/svg">
        <valueCode value="400,20" />
      </extension>
      <path value="NamingSystem.contact" />
      <short value="Contact details for the publisher" />
      <definition value="Contact details to assist a user in finding and communicating with the publisher." />
      <comment value="May be a web site, an email address, a telephone number, etc." />
      <min value="0" />
      <max value="*" />
      <type>
        <code value="ContactDetail" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="workflow" />
        <map value="Definition.contact" />
      </mapping>
    </element>
    <element id="NamingSystem.responsible">
      <path value="NamingSystem.responsible" />
      <short value="Who maintains system namespace?" />
      <definition value="The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision." />
      <comment value="This is the primary organization.  Responsibility for some aspects of a namespace may be delegated." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.witness" />
      </mapping>
    </element>
    <element id="NamingSystem.type">
      <path value="NamingSystem.type" />
      <short value="e.g. driver,  provider,  patient, bank etc." />
      <definition value="Categorizes a naming system for easier search by grouping related naming systems." />
      <comment value="This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="CodeableConcept" />
      </type>
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="IdentifierType" />
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true" />
        </extension>
        <strength value="extensible" />
        <description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." />
        <valueSet value="http://hl7.org/fhir/ValueSet/identifier-type" />
      </binding>
    </element>
    <element id="NamingSystem.description">
      <path value="NamingSystem.description" />
      <short value="Natural language description of the naming system" />
      <definition value="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 value="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 value="0" />
      <max value="1" />
      <type>
        <code value="markdown" />
      </type>
      <mapping>
        <identity value="workflow" />
        <map value="Definition.description" />
      </mapping>
    </element>
    <element id="NamingSystem.useContext">
      <path value="NamingSystem.useContext" />
      <short value="The context that the content is intended to support" />
      <definition value="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 value="When multiple useContexts are specified, there is no expectation that all or any of the contexts apply." />
      <requirements value="Assist in searching for appropriate content." />
      <min value="0" />
      <max value="*" />
      <type>
        <code value="UsageContext" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="workflow" />
        <map value="Definition.useContext" />
      </mapping>
    </element>
    <element id="NamingSystem.jurisdiction">
      <path value="NamingSystem.jurisdiction" />
      <short value="Intended jurisdiction for naming system (if applicable)" />
      <definition value="A legal or geographic region in which the naming system is intended to be used." />
      <comment value="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 value="0" />
      <max value="*" />
      <type>
        <code value="CodeableConcept" />
      </type>
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="Jurisdiction" />
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true" />
        </extension>
        <strength value="extensible" />
        <description value="Countries and regions within which this artifact is targeted for use." />
        <valueSet value="http://hl7.org/fhir/ValueSet/jurisdiction" />
      </binding>
      <mapping>
        <identity value="workflow" />
        <map value="Definition.jurisdiction" />
      </mapping>
    </element>
    <element id="NamingSystem.usage">
      <path value="NamingSystem.usage" />
      <short value="How/where is it used" />
      <definition value="Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
    </element>
    <element id="NamingSystem.uniqueId">
      <extension url="http://hl7.org/fhir/build/StructureDefinition/svg">
        <valueCode value="400,120" />
      </extension>
      <path value="NamingSystem.uniqueId" />
      <short value="Unique identifiers used for system" />
      <definition value="Indicates how the system may be identified when referenced in electronic exchange." />
      <comment value="Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc." />
      <min value="1" />
      <max value="*" />
      <type>
        <code value="BackboneElement" />
      </type>
      <isSummary value="true" />
    </element>
    <element id="NamingSystem.uniqueId.type">
      <path value="NamingSystem.uniqueId.type" />
      <short value="oid | uuid | uri | v2csmnemonic | other" />
      <definition value="Identifies the unique identifier scheme used for this particular identifier." />
      <comment value="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 value="1" />
      <max value="1" />
      <type>
        <code value="code" />
      </type>
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="NamingSystemIdentifierType" />
        </extension>
        <strength value="required" />
        <description value="Identifies the style of unique identifier used to identify a namespace." />
        <valueSet value="http://hl7.org/fhir/ValueSet/namingsystem-identifier-type" />
      </binding>
    </element>
    <element id="NamingSystem.uniqueId.value">
      <path value="NamingSystem.uniqueId.value" />
      <short value="The unique identifier" />
      <definition value="The string that should be sent over the wire to identify the code system or identifier system." />
      <comment value="If the value is a URI intended for use as FHIR system identifier, the URI should not contain &quot;\&quot; or &quot;?&quot; or &quot;,&quot; since this makes escaping very difficult." />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.identifier" />
      </mapping>
    </element>
    <element id="NamingSystem.uniqueId.preferred">
      <path value="NamingSystem.uniqueId.preferred" />
      <short value="Is this the id that should be used for this type" />
      <definition value="Indicates whether this identifier is the &quot;preferred&quot; identifier of this type." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="boolean" />
      </type>
      <constraint>
        <key value="nsd-2" />
        <severity value="error" />
        <human value="Can't have more than one preferred identifier for a type" />
        <expression value="uniqueId.where(preferred = true).select(type).isDistinct()" />
        <xpath value="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()])&gt;1) then $type else ()))" />
        <source value="http://hl7.org/fhir/StructureDefinition/NamingSystem" />
      </constraint>
      <meaningWhenMissing value="If there are multiple ids, and one is labeled &quot;preferred&quot;, then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn" />
    </element>
    <element id="NamingSystem.uniqueId.comment">
      <path value="NamingSystem.uniqueId.comment" />
      <short value="Notes about identifier usage" />
      <definition value="Notes about the past or intended usage of this identifier." />
      <comment value="e.g. &quot;must be used in Germany&quot; or &quot;was initially published in error with this value&quot;." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
    </element>
    <element id="NamingSystem.uniqueId.period">
      <path value="NamingSystem.uniqueId.period" />
      <short value="When is identifier valid?" />
      <definition value="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 value="Within a registry, a given identifier should only be &quot;active&quot; for a single namespace at a time.  (Ideally, an identifier should only ever be associated with a single namespace across all time)." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="Period" />
      </type>
    </element>
    <element id="NamingSystem.uniqueId.authoritative">
      <path value="NamingSystem.uniqueId.authoritative" />
      <short value="Whether the identifier is authoritative" />
      <definition value="Indicates whether this identifier ie endorsed by the official owner of the associated naming system." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="boolean" />
      </type>
      <constraint>
        <key value="nsd-3" />
        <severity value="error" />
        <human value="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 value="uniqueId.where(authoritative = true).select(type).isDistinct().select(period).isDistinct()" />
        <xpath value="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()])&gt;1) then $type else ()))" />
        <source value="http://hl7.org/fhir/StructureDefinition/NamingSystem" />
      </constraint>
    </element>
  </differential>
</StructureDefinition>