Namingsystem.profile.xml

StructureDefinition for namingsystem

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="NamingSystem"/>
  <meta>
    <lastUpdated value="2015-03-27T00:13:00.999+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/NamingSystem"/>
  <name value="NamingSystem"/>
  <publisher value="HL7 FHIR Project (FHIR Management Group)"/>
  <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/fhirmg/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for NamingSystem Resource"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <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="1"/>
      <max value="1"/>
      <type>
        <code value="NamingSystem"/>
      </type>
      <constraint>
        <key value="nsd-2"/>
        <severity value="error"/>
        <human value="Can't have more than one preferred identifier for a type"/>
        <xpath value="not(exists(for $type in distinct-values(f:uniqueId/f:type) return if (count(f:uniqueId[f:type/@value
        =$type and f:primary/@value='true'])&gt;1) then $type else ()))"/>
      </constraint>
      <constraint>
        <key value="nsd-3"/>
        <severity value="error"/>
        <human value="Can only have replacedBy if namingsystem is retired"/>
        <xpath value="not(f:replacedBy) or f:status/@value='retired'"/>
      </constraint>
      <constraint>
        <key value="nsd-1"/>
        <severity value="error"/>
        <human value="Root systems cannot have uuid or sid identifiers"/>
        <xpath value="not(f:type/@value='root' and f:uniqueId/f:type=('uuid', 'ruid'))"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="NamingSystem.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="NamingSystem.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="Asserting this rule set restricts the content to be only understood by a limited set of
       trading partners. This inherently limits the usefulness of the data in the long term.
       However the existing health eco-system is highly fractured, and not yet ready to define,
       collect, and exchange data in a generally computable sense. Wherever possible, implementers
       and/or specification writers should avoid using this element as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="NamingSystem.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="A human-readable narrative that contains a summary of the resource, and may be used to
       represent the content of the resource to a human. The narrative need not encode all the
       structured data, but is required to contain sufficient detail to make it &quot;clinically
       safe&quot; for a human to just read the narrative. Resource definitions may define what
       content should be represented in the narrative to ensure clinical safety."/>
      <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="These resources do not have an independent existence apart from the resource that contains
       them - they cannot be identified independently, and nor can they have their own independent
       transaction scope."/>
      <comments value="This should never be done when the content can be identified properly, as once identification
       is lost, it is extremely difficult (and context dependent) to restore it again."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource, and that modifies the understanding of the element that contains it.
       Usually modifier elements provide negation or qualification. In order to make the use
       of extensions safe and manageable, there is a strict set of governance applied to the
       definition and use of extensions. Though any implementer is allowed to define an extension,
       there is a set of requirements that SHALL be met as part of the definition of the extension.
       Applications processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.type"/>
      <short value="codesystem | identifier | root"/>
      <definition value="Indicates the purpose for the namingsystem - what kinds of things does it make unique?"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="NamingSystemType"/>
        <strength value="required"/>
        <description value="Identifies the purpose of the namingsystem"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/namingsystem-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.name"/>
      <short value="Human-readable label"/>
      <definition value="The descriptive name of this particular identifier type or code system."/>
      <comments value="The&quot;symbolic name&quot; for an OID would be captured as an extension."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="NamingSystem.date"/>
      <short value="Publication Date(/time)"/>
      <definition value="The date  (and optionally time) when the system was registered or published."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.status"/>
      <short value="draft | active | retired"/>
      <definition value="Indicates whether the namingsystem is &quot;ready for use&quot; or not."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="ConformanceResourceStatus"/>
        <strength value="required"/>
        <description value="The lifecycle status of a Value Set or Concept Map"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/conformance-resource-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.country"/>
      <short value="ISO 3-char country code"/>
      <definition value="If present, indicates that the identifier or code system is principally intended for use
       or applies to entities within the specified country.  For example, the country associated
       with a national code system."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Country"/>
        <strength value="required"/>
        <description value="Codes for identifying countries"/>
        <valueSetUri value="http://www.iso.org/iso/country_codes"/>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.category"/>
      <short value="e.g. driver,  provider,  patient, bank etc"/>
      <definition value="Categorizes a namingsystem for easier search by grouping related namingsystems."/>
      <comments 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>
        <name value="NamingSystemCategory"/>
        <strength value="required"/>
        <description value="Identifies the general purpose of the namingsystem identifiers provided.  E.g. Driver,
         Provider, Patient, Bank, etc."/>
      </binding>
    </element>
    <element>
      <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."/>
      <comments 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>
    </element>
    <element>
      <path value="NamingSystem.description"/>
      <short value="What does namingsystem identify?"/>
      <definition value="Details about what the namespace identifies including scope, granularity, version labeling,
       etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <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>
      <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."/>
      <comments value="Multiple identifiers may exist, either due to duplicate registration, regional rules,
       needs of different communication technologies, etc."/>
      <min value="1"/>
      <max value="*"/>
    </element>
    <element>
      <path value="NamingSystem.uniqueId.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.uniqueId.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.uniqueId.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.uniqueId.type"/>
      <short value="oid | uuid | uri | other"/>
      <definition value="Identifies the unique identifier scheme used for this particular identifier."/>
      <comments 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>
      <binding>
        <name value="NamingSystemIdentifierType"/>
        <strength value="required"/>
        <description value="Identifies the style of unique identifier used to identify a namepace"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/namingsystem-identifier-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <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."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <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>
    </element>
    <element>
      <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 namingsystem.  Outside of this window, the identifier might be non-deterministic."/>
      <comments 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>
      <path value="NamingSystem.publisher"/>
      <short value="Name of the publisher (Organization or individual)"/>
      <definition value="The name of the individual or organization that published the naming system."/>
      <comments value="Usually an organization, but may be an individual. 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"/>
    </element>
    <element>
      <path value="NamingSystem.contact"/>
      <short value="Contact details of the publisher"/>
      <definition value="Contacts to assist a user in finding and communicating with the publisher."/>
      <comments value="May be a web site, an email address, a telephone number (tel:), etc."/>
      <min value="0"/>
      <max value="*"/>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.contact.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.contact.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.contact.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.contact.name"/>
      <short value="Name of a individual to contact"/>
      <definition value="The name of an individual to contact regarding the naming system."/>
      <comments value="If there is no named individual, the telecom is for the organization as a whole."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.contact.telecom"/>
      <short value="Contact details for individual or publisher"/>
      <definition value="Contact details for individual (if a name was provided) or the publisher."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.replacedBy"/>
      <short value="Use this instead"/>
      <definition value="For namingsystems that are retired, indicates the namingsystem that should be used in
       their place (if any)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/NamingSystem"/>
      </type>
      <condition value="nsd-3"/>
    </element>
  </snapshot>
  <differential>
    <element>
      <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="1"/>
      <max value="1"/>
      <type>
        <code value="DomainResource"/>
      </type>
      <constraint>
        <key value="nsd-2"/>
        <severity value="error"/>
        <human value="Can't have more than one preferred identifier for a type"/>
        <xpath value="not(exists(for $type in distinct-values(f:uniqueId/f:type) return if (count(f:uniqueId[f:type/@value
        =$type and f:primary/@value='true'])&gt;1) then $type else ()))"/>
      </constraint>
      <constraint>
        <key value="nsd-3"/>
        <severity value="error"/>
        <human value="Can only have replacedBy if namingsystem is retired"/>
        <xpath value="not(f:replacedBy) or f:status/@value='retired'"/>
      </constraint>
      <constraint>
        <key value="nsd-1"/>
        <severity value="error"/>
        <human value="Root systems cannot have uuid or sid identifiers"/>
        <xpath value="not(f:type/@value='root' and f:uniqueId/f:type=('uuid', 'ruid'))"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="NamingSystem.type"/>
      <short value="codesystem | identifier | root"/>
      <definition value="Indicates the purpose for the namingsystem - what kinds of things does it make unique?"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="NamingSystemType"/>
        <strength value="required"/>
        <description value="Identifies the purpose of the namingsystem"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/namingsystem-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.name"/>
      <short value="Human-readable label"/>
      <definition value="The descriptive name of this particular identifier type or code system."/>
      <comments value="The&quot;symbolic name&quot; for an OID would be captured as an extension."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="NamingSystem.date"/>
      <short value="Publication Date(/time)"/>
      <definition value="The date  (and optionally time) when the system was registered or published."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.status"/>
      <short value="draft | active | retired"/>
      <definition value="Indicates whether the namingsystem is &quot;ready for use&quot; or not."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <binding>
        <name value="ConformanceResourceStatus"/>
        <strength value="required"/>
        <description value="The lifecycle status of a Value Set or Concept Map"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/conformance-resource-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.country"/>
      <short value="ISO 3-char country code"/>
      <definition value="If present, indicates that the identifier or code system is principally intended for use
       or applies to entities within the specified country.  For example, the country associated
       with a national code system."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Country"/>
        <strength value="required"/>
        <description value="Codes for identifying countries"/>
        <valueSetUri value="http://www.iso.org/iso/country_codes"/>
      </binding>
    </element>
    <element>
      <path value="NamingSystem.category"/>
      <short value="e.g. driver,  provider,  patient, bank etc"/>
      <definition value="Categorizes a namingsystem for easier search by grouping related namingsystems."/>
      <comments 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>
        <name value="NamingSystemCategory"/>
        <strength value="required"/>
        <description value="Identifies the general purpose of the namingsystem identifiers provided.  E.g. Driver,
         Provider, Patient, Bank, etc."/>
      </binding>
    </element>
    <element>
      <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."/>
      <comments 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>
    </element>
    <element>
      <path value="NamingSystem.description"/>
      <short value="What does namingsystem identify?"/>
      <definition value="Details about what the namespace identifies including scope, granularity, version labeling,
       etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <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>
      <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."/>
      <comments value="Multiple identifiers may exist, either due to duplicate registration, regional rules,
       needs of different communication technologies, etc."/>
      <min value="1"/>
      <max value="*"/>
    </element>
    <element>
      <path value="NamingSystem.uniqueId.type"/>
      <short value="oid | uuid | uri | other"/>
      <definition value="Identifies the unique identifier scheme used for this particular identifier."/>
      <comments 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>
      <binding>
        <name value="NamingSystemIdentifierType"/>
        <strength value="required"/>
        <description value="Identifies the style of unique identifier used to identify a namepace"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/namingsystem-identifier-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <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."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <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>
    </element>
    <element>
      <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 namingsystem.  Outside of this window, the identifier might be non-deterministic."/>
      <comments 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>
      <path value="NamingSystem.publisher"/>
      <short value="Name of the publisher (Organization or individual)"/>
      <definition value="The name of the individual or organization that published the naming system."/>
      <comments value="Usually an organization, but may be an individual. 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"/>
    </element>
    <element>
      <path value="NamingSystem.contact"/>
      <short value="Contact details of the publisher"/>
      <definition value="Contacts to assist a user in finding and communicating with the publisher."/>
      <comments value="May be a web site, an email address, a telephone number (tel:), etc."/>
      <min value="0"/>
      <max value="*"/>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.contact.name"/>
      <short value="Name of a individual to contact"/>
      <definition value="The name of an individual to contact regarding the naming system."/>
      <comments value="If there is no named individual, the telecom is for the organization as a whole."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.contact.telecom"/>
      <short value="Contact details for individual or publisher"/>
      <definition value="Contact details for individual (if a name was provided) or the publisher."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="NamingSystem.replacedBy"/>
      <short value="Use this instead"/>
      <definition value="For namingsystems that are retired, indicates the namingsystem that should be used in
       their place (if any)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/NamingSystem"/>
      </type>
      <condition value="nsd-3"/>
    </element>
  </differential>
</StructureDefinition>