Operation-namingsystem-translate-id.xml

Operation Definition

<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="NamingSystem-translate-id"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> translate-id</h2> 
      <p> OPERATION: translate-id</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/NamingSystem-translate-id</pre> 
      <div> 
        <p> This operation returns an identifier of the target type. The operation takes 5 parameters:</p> 

        <ul> 

          <li> 

            <p> a source identifier value - either a URI, an OID, or a v2 table 0396 (other) code</p> 

          </li> 

          <li> 

            <p> a code for what type of identifier the source identifier is</p> 

          </li> 

          <li> 

            <p> a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier)</p> 

          </li> 

          <li> 

            <p> a optional parameter preferredOnly for whether only the preferred identifier is desired</p> 

          </li> 

          <li> 

            <p> an optional date to return only identifiers that have a validity period that includes
               that date</p> 

          </li> 

        </ul> 

        <p> and returns either the requested identifier(s), or an HTTP errors response with an OperationOutcome
           because either the provided identifier was not recognized, or the requested identiifer
           type is not known.</p> 

      </div> 
      <p> URL: [base]/NamingSystem/$translate-id</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Cardinality</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Binding</b> 
          </td> 
          <td> 
            <b> Documentation</b> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> id</td> 
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The server parses the provided identifier to see what type it is (e.g. a URI, an OID as
                 a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier
                 it is, it can try it as multiple types. It is an error if more than one system matches
                 the provided identifier</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> sourceType</td> 
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td> http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.6.0|4.6.0 (Required)</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> targetType</td> 
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td> http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.6.0|4.6.0 (Required)</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> preferredOnly</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> If preferredOnly = true then return only the preferred identifier, or if preferredOnly
                 = false then return all available ids.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> date</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#dateTime">dateTime</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> If 'date' is supplied return only ids that have a validity period that includes that date.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> result</td> 
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> True if the identifier could be translated successfully.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> targetIdentifier</td> 
          <td> 0..*</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The target identifer(s) of the requested type</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> targetIdentifer.preferred</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Whether the target identifier is preferred.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> targetIdentifier.period</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The perioid when the target identifier is valid.</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div> 
        <p> Servers handle this request by finding the provided identifier in their known naming systems,
           and returning the requested identifier type (
          <a href="namingsystem-definitions.html#NamingSystem.uniqueId.type">NamingSystem.uniqueId.type</a> ).
        </p> 

        <p> If the server wishes, it can also look through all code systems and value sets it knows
           about when attempting to find the requested identifier</p> 

      </div> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/NamingSystem-translate-id"/> 
  <version value="4.6.0"/> 
  <name value="translate-id"/> 
  <title value="Translate id"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2021-04-15T12:25:09+10:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="This operation returns an identifier of the target type. The operation takes 5 parameters:
       

* a source identifier value - either a URI, an OID, or a v2 table 0396 (other) code  
*  a code for what type of identifier the source identifier is     

* a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier) 
      

* a optional parameter preferredOnly for whether only the preferred identifier is desired
       

* an optional date to return only identifiers that have a validity period that includes
   that date   

and returns either the requested identifier(s), or an HTTP errors response with an OperationOutcome
   because either the provided identifier was not recognized, or the requested identiifer
   type is not known."/> 
  <affectsState value="false"/> 
  <code value="translate-id"/> 
  <comment value="Servers handle this request by finding the provided identifier in their known naming systems,
   and returning the requested identifier type ([NamingSystem.uniqueId.type](namingsystem-definitions.h
  tml#NamingSystem.uniqueId.type)).  

If the server wishes, it can also look through all code systems and value sets it knows
   about when attempting to find the requested identifier"/> 
  <resource value="NamingSystem"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="false"/> 
  <parameter> 
    <name value="id"/> 
    <use value="in"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="The server parses the provided identifier to see what type it is (e.g. a URI, an OID as
     a URI, a plain OID, or a v2 table 0396 code). If the server can't tell what type of identifier
     it is, it can try it as multiple types. It is an error if more than one system matches
     the provided identifier"/> 
    <type value="string"/> 
  </parameter> 
  <parameter> 
    <name value="sourceType"/> 
    <use value="in"/> 
    <min value="1"/> 
    <max value="1"/> 
    <type value="code"/> 
    <binding> 
      <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
        <valueString value="NamingSystemIdentifierType"/> 
      </extension> 
      <strength value="required"/> 
      <valueSet value="http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.6.0|4.6.0"/> 
    </binding> 
  </parameter> 
  <parameter> 
    <name value="targetType"/> 
    <use value="in"/> 
    <min value="1"/> 
    <max value="1"/> 
    <type value="code"/> 
    <binding> 
      <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
        <valueString value="NamingSystemIdentifierType"/> 
      </extension> 
      <strength value="required"/> 
      <valueSet value="http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.6.0|4.6.0"/> 
    </binding> 
  </parameter> 
  <parameter> 
    <name value="preferredOnly"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="If preferredOnly = true then return only the preferred identifier, or if preferredOnly
     = false then return all available ids."/> 
    <type value="boolean"/> 
  </parameter> 
  <parameter> 
    <name value="date"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="If 'date' is supplied return only ids that have a validity period that includes that date."/> 
    <type value="dateTime"/> 
  </parameter> 
  <parameter> 
    <name value="result"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="True if the identifier could be translated successfully."/> 
    <type value="boolean"/> 
  </parameter> 
  <parameter> 
    <name value="targetIdentifier"/> 
    <use value="out"/> 
    <min value="0"/> 
    <max value="*"/> 
    <documentation value="The target identifer(s) of the requested type"/> 
    <type value="boolean"/> 
  </parameter> 
  <parameter> 
    <name value="targetIdentifer.preferred"/> 
    <use value="out"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Whether the target identifier is preferred."/> 
    <type value="boolean"/> 
  </parameter> 
  <parameter> 
    <name value="targetIdentifier.period"/> 
    <use value="out"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The perioid when the target identifier is valid."/> 
    <type value="boolean"/> 
  </parameter> 
</OperationDefinition>