R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3

V3-IdentifierScope.cs.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

Description: Codes to specify the scope in which the identifier applies to the object with which it is associated, and used in the datatype property II.

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-IdentifierScope"/> 
  <meta> 
    <lastUpdated value="2017-07-31T00:00:00.000+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Release Date: 2017-07-31</p> 

      <table class="grid">
 
        <tr> 
          <td> 
            <b> Level</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> BUSN
            <a name="v3-IdentifierScope-BUSN"> </a> 
          </td> 
          <td> Business Identifier</td> 
          <td> 
                        
                           Description: An identifier whose scope is defined by the business
               practices associated with the object. In contrast to the other scope identifiers, the
               scope of the use of the id is not necessarily restricted to a single object, but may be
               reused for other objects closely associated with the object due to business practice.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> OBJ
            <a name="v3-IdentifierScope-OBJ"> </a> 
          </td> 
          <td> Object Identifier</td> 
          <td> 
                        
                           Description: The identifier associated with a particular object.
               It remains consistent as the object undergoes state transitions.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> VER
            <a name="v3-IdentifierScope-VER"> </a> 
          </td> 
          <td> Version Identifier</td> 
          <td> 
                        
                           Description: An identifier that references a particular object
               as it existed at a given point in time. The identifier SHALL change with each state transition
               on the object. I.e. The version identifier of an object prior to a 'suspend' state transition
               is distinct from the identifier of the object after the state transition. Each version
               identifier can be tied to exactly one ControlAct event which brought that version into
               being (though the control act may never be instantiated).
            <br/>  

                        
                            NOTE: Applications that do not support versioning of objects
               must ignore and not persist these ids to avoid confusion resulting from leaving the same
               identifier on an object that undergoes changes. 
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> VW
            <a name="v3-IdentifierScope-VW"> </a> 
          </td> 
          <td> View Specific Identifier</td> 
          <td> 
                        
                           Description: An identifier that references a particular object
               as it existed at a given point in time. The identifier SHALL change with each state transition
               on the object.
            <br/>  

                        
                           Example The version identifier of an object prior to a 'suspend'
               state transition is distinct from the identifier of the object after the state transition.
               Each version identifier can be tied to exactly one ControlAct event which brought that
               version into being (though the control act may never be instantiated).
            <br/>  

                        
                            NOTE: Applications that do not support versioning of objects
               must ignore and not persist these ids to avoid confusion resulting from leaving the same
               identifier on an object that undergoes changes. 
            <br/>  

                     
          </td> 
        </tr> 

      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status">
    <valueString value="External"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/v3/IdentifierScope"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.5.1116"/> 
  </identifier> 
  <version value="2017-07-31"/> 
  <name value="v3 Code System IdentifierScope"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2017-07-31T00:00:00+10:00"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="  Description:
Codes to specify the scope in which the identifier applies to the object with which it
     is associated, and used in the datatype property II."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/v3-IdentifierScope"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="BUSN"/> 
    <display value="Business Identifier"/> 
    <definition value="Description: An identifier whose scope is defined by the business practices associated
       with the object. In contrast to the other scope identifiers, the scope of the use of the
       id is not necessarily restricted to a single object, but may be reused for other objects
       closely associated with the object due to business practice."/> 
  </concept> 
  <concept> 
    <code value="OBJ"/> 
    <display value="Object Identifier"/> 
    <definition value="Description: The identifier associated with a particular object. It remains consistent
       as the object undergoes state transitions."/> 
  </concept> 
  <concept> 
    <code value="VER"/> 
    <display value="Version Identifier"/> 
    <definition value="Description: An identifier that references a particular object as it existed at a given
       point in time. The identifier SHALL change with each state transition on the object. I.e.
       The version identifier of an object prior to a 'suspend' state transition is distinct
       from the identifier of the object after the state transition. Each version identifier
       can be tied to exactly one ControlAct event which brought that version into being (though
       the control act may never be instantiated).

                        
                            NOTE: Applications that do not support versioning of objects
       must ignore and not persist these ids to avoid confusion resulting from leaving the same
       identifier on an object that undergoes changes."/> 
  </concept> 
  <concept> 
    <code value="VW"/> 
    <display value="View Specific Identifier"/> 
    <definition value="Description: An identifier that references a particular object as it existed at a given
       point in time. The identifier SHALL change with each state transition on the object.

                        
                           Example The version identifier of an object prior to a 'suspend'
       state transition is distinct from the identifier of the object after the state transition.
       Each version identifier can be tied to exactly one ControlAct event which brought that
       version into being (though the control act may never be instantiated).

                        
                            NOTE: Applications that do not support versioning of objects
       must ignore and not persist these ids to avoid confusion resulting from leaving the same
       identifier on an object that undergoes changes."/> 
  </concept> 
</CodeSystem> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.