HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

NationalProviderIdentifierModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-entity-NationalProviderIdentifier-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC NationalProviderIdentifier Logical Model</b></p>
  <p>A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-NationalProviderIdentifier-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.entity.NationalProviderIdentifier"/>
  </identifier>
  <version value="0.2.0"/>
  <name value="NationalProviderIdentifierModel"/>
  <title value="BC NationalProviderIdentifier Logical Model"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
  <keyword>
    <system value="http://ncimeta.nci.nih.gov"/>
    <code value="C1549728"/>
  </keyword>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-entity-NationalProviderIdentifier-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-entity-NationalProviderIdentifier-model">
      <path value="cimi-entity-NationalProviderIdentifier-model"/>
      <definition
                  value="A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.value">
      <path value="cimi-entity-NationalProviderIdentifier-model.value"/>
      <short
             value="String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
      <definition
                  value="String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.purpose">
      <path value="cimi-entity-NationalProviderIdentifier-model.purpose"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0805701"/>
      </code>
      <short value="Why the item is used."/>
      <definition value="Why the item is used."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.purpose"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/identifier-use"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.type">
      <path value="cimi-entity-NationalProviderIdentifier-model.type"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0332307"/>
      </code>
      <short
             value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.type"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/identifier-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.codeSystem">
      <path value="cimi-entity-NationalProviderIdentifier-model.codeSystem"/>
      <short value="A formal terminology system."/>
      <definition value="A formal terminology system."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.codeSystem"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element
             id="cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod">
      <path
            value="cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2985763"/>
      </code>
      <short
             value="The date and time span for which something is active, valid, or in force."/>
      <definition
                  value="The date and time span for which something is active, valid, or in force."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path
              value="cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.issuer">
      <path value="cimi-entity-NationalProviderIdentifier-model.issuer"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1561598"/>
      </code>
      <short
             value="An organization who issues a qualification, identifier, or license."/>
      <definition
                  value="An organization who issues a qualification, identifier, or license."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.issuer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-entity-NationalProviderIdentifier-model">
      <path value="cimi-entity-NationalProviderIdentifier-model"/>
      <definition
                  value="A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.value">
      <path value="cimi-entity-NationalProviderIdentifier-model.value"/>
      <short
             value="String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
      <definition
                  value="String representing a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.purpose">
      <path value="cimi-entity-NationalProviderIdentifier-model.purpose"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0805701"/>
      </code>
      <short value="Why the item is used."/>
      <definition value="Why the item is used."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.purpose"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/identifier-use"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.type">
      <path value="cimi-entity-NationalProviderIdentifier-model.type"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0332307"/>
      </code>
      <short
             value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.type"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/identifier-type"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.codeSystem">
      <path value="cimi-entity-NationalProviderIdentifier-model.codeSystem"/>
      <short value="A formal terminology system."/>
      <definition value="A formal terminology system."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.codeSystem"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element
             id="cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod">
      <path
            value="cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2985763"/>
      </code>
      <short
             value="The date and time span for which something is active, valid, or in force."/>
      <definition
                  value="The date and time span for which something is active, valid, or in force."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path
              value="cimi-entity-NationalProviderIdentifier-model.effectiveTimePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-NationalProviderIdentifier-model.issuer">
      <path value="cimi-entity-NationalProviderIdentifier-model.issuer"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1561598"/>
      </code>
      <short
             value="An organization who issues a qualification, identifier, or license."/>
      <definition
                  value="An organization who issues a qualification, identifier, or license."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-NationalProviderIdentifier-model.issuer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>