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 
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="cimi-entity-NationalProviderIdentifier"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p><b>BC NationalProviderIdentifier Profile</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> <p><b>BC Mapping Summary</b></p> <p><pre>cimi.entity.NationalProviderIdentifier maps to Identifier: string maps to value Purpose maps to use Type maps to type CodeSystem maps to system EffectiveTimePeriod maps to period Issuer maps to assigner </pre></p> </div> </text> <url value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-NationalProviderIdentifier"/> <identifier> <system value="http://hl7.org/fhir/us/breastcancer"/> <value value="cimi.entity.NationalProviderIdentifier"/> </identifier> <version value="0.2.0"/> <name value="NationalProviderIdentifierProfile"/> <title value="BC NationalProviderIdentifier Profile"/> <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."/> <purpose value="Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation."/> <fhirVersion value="3.0.1"/> <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="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <type value="Identifier"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier"/> <derivation value="constraint"/> <snapshot> <element id="Identifier:cimi-entity-NationalProviderIdentifier"> <path value="Identifier"/> <short value="BC NationalProviderIdentifier Profile"/> <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="*"/> <condition value="ele-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)"/> </mapping> <mapping> <identity value="rim"/> <map value="II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"/> </mapping> <mapping> <identity value="servd"/> <map value="Identifier"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.id"> <path value="Identifier.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). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.extension"> <path value="Identifier.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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."/> <comment 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="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.use"> <path value="Identifier.use"/> <short value="usual | official | temp | secondary (If known)"/> <definition value="The purpose of this identifier."/> <comment value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/> <requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IdentifierUse"/> </extension> <strength value="required"/> <description value="Identifies the purpose for this identifier, if known ."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.code or implied by context"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.type"> <path value="Identifier.type"/> <short value="Description of identifier"/> <definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."/> <comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type."/> <requirements value="Allows users to make use of identifiers when the identifier system is not known."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <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."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="CX.5"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.code or implied by context"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.system"> <path value="Identifier.system"/> <short value="The namespace for the identifier value"/> <definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique."/> <requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.4 / EI-2-4"/> </mapping> <mapping> <identity value="rim"/> <map value="II.root or Role.id.root"/> </mapping> <mapping> <identity value="servd"/> <map value="./IdentifierType"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.value"> <path value="Identifier.value"/> <short value="The value that is unique"/> <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."/> <comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html)."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.1 / EI.1"/> </mapping> <mapping> <identity value="rim"/> <map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/> </mapping> <mapping> <identity value="servd"/> <map value="./Value"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.period"> <path value="Identifier.period"/> <short value="Time period when id is/was valid for use"/> <definition value="Time period during which identifier is/was valid for use."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.7 + CX.8"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.effectiveTime or implied by context"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.assigner"> <path value="Identifier.assigner"/> <short value="Organization that issued id (may be just text)"/> <definition value="Organization that issued/manages the identifier."/> <comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.4 / (CX.4,CX.9,CX.10)"/> </mapping> <mapping> <identity value="rim"/> <map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"/> </mapping> <mapping> <identity value="servd"/> <map value="./IdentifierIssuingAuthority"/> </mapping> </element> </snapshot> <differential> <element id="Identifier:cimi-entity-NationalProviderIdentifier"> <path value="Identifier"/> <short value="BC NationalProviderIdentifier Profile"/> <definition value="A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry."/> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.value"> <path value="Identifier.value"/> <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"/> </element> <element id="Identifier:cimi-entity-NationalProviderIdentifier.assigner"> <path value="Identifier.assigner"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization"/> </type> </element> </differential> </StructureDefinition>