3.33.9 StructureDefinition: Shared Health Identifier - XML Profile
XML representation of the dtprofile-identifier Profile.
Narrative view of the profile
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="dtprofile-identifier"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-identifier-definitions.html#Identifier" title="null">Identifier</a><a name="Identifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-identifier-definitions.html#Identifier.system" title="null">system</a><a name="Identifier.system"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-identifier-definitions.html#Identifier.value" title="null">value</a><a name="Identifier.value"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/2016may/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier"/> <version value="2.0 Revision F"/> <name value="Shared Health Identifier"/> <status value="draft"/> <date value="2015-09-22T06:02:49-04:00"/> <description value="Constraints on the Identifier data type"/> <fhirVersion value="1.4.0"/> <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> <mapping> <identity value="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <kind value="datatype"/> <abstract value="false"/> <baseType value="Identifier"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier"/> <derivation value="constraint"/> <snapshot> <element id="Identifier"> <path value="Identifier"/> <short value="An identifier intended for computation"/> <definition value="A technical identifier - identifies some entity uniquely and unambiguously."/> <min value="0"/> <max value="*"/> <base> <path value="Identifier"/> <min value="0"/> <max value="*"/> </base> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <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.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)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Identifier.extension"> <path value="Identifier.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="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Identifier.use"> <path value="Identifier.use"/> <short value="usual | official | temp | secondary (If known)"/> <definition value="The purpose of this identifier."/> <comments 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"/> <base> <path value="Identifier.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <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.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."/> <comments 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"/> <base> <path value="Identifier.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <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.system"> <path value="Identifier.system"/> <short value="The namespace for the identifier"/> <definition value="Establishes the namespace in which set of possible id values is unique."/> <requirements value="There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers."/> <min value="1"/> <max value="1"/> <base> <path value="Identifier.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <exampleUri value="http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"/> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <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.value"> <path value="Identifier.value"/> <short value="The value that is unique"/> <definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system."/> <comments 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"/> <base> <path value="Identifier.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="123456"/> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <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.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"/> <base> <path value="Identifier.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <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.assigner"> <path value="Identifier.assigner"/> <short value="Organization that issued id (may be just text)"/> <definition value="Organization that issued/manages the identifier."/> <comments 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"/> <base> <path value="Identifier.assigner"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <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"> <path value="Identifier"/> <mustSupport value="true"/> </element> <element id="Identifier.system"> <path value="Identifier.system"/> <min value="1"/> <mustSupport value="true"/> </element> <element id="Identifier.value"> <path value="Identifier.value"/> <min value="1"/> <mustSupport value="true"/> </element> </differential> </StructureDefinition>