FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/NamingSystem-translate-id (JSON)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "NamingSystem-translate-id",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><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>Scope</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/><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>\n</div></td></tr><tr><td>IN</td><td>sourceType</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td><a href=\"valueset-namingsystem-identifier-type.html\">Naming System Identifier Type</a> (Required)</td><td/></tr><tr><td>IN</td><td>targetType</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td><a href=\"valueset-namingsystem-identifier-type.html\">Naming System Identifier Type</a> (Required)</td><td/></tr><tr><td>IN</td><td>preferredOnly</td><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>\n</div></td></tr><tr><td>IN</td><td>date</td><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>\n</div></td></tr><tr><td>OUT</td><td>result</td><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>\n</div></td></tr><tr><td>OUT</td><td>targetIdentifier</td><td/><td>0..*</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The target identifer(s) of the requested type</p>\n</div></td></tr><tr><td>OUT</td><td>targetIdentifer.preferred</td><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>\n</div></td></tr><tr><td>OUT</td><td>targetIdentifier.period</td><td/><td>0..1</td><td><a href=\"datatypes.html#Period\">Period</a></td><td/><td><div><p>The perioid when the target identifier is valid.</p>\n</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>\n<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>\n</div></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/NamingSystem-translate-id",
  "version" : "6.0.0-cibuild",
  "name" : "TranslateId",
  "title" : "Translate id",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2024-02-13T22:01:30+00:00",
  "publisher" : "HL7 International / Terminology Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/Vocab"
    }]
  }],
  "description" : "This operation returns an identifier of the target type. The operation takes 5 parameters:     \n\n* a source identifier value - either a URI, an OID, or a v2 table 0396 (other) code  \n*  a code for what type of identifier the source identifier is     \n\n* a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier)     \n\n* an optional parameter preferredOnly for whether only the preferred identifier is desired     \n\n* an optional date to return only identifiers that have a validity period that includes that date   \n\nand 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.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : false,
  "code" : "translate-id",
  "comment" : "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.html#NamingSystem.uniqueId.type)).  \n\nIf 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" : ["NamingSystem"],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [{
    "name" : "id",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "documentation" : "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" : "string"
  },
  {
    "name" : "sourceType",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "type" : "code",
    "binding" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
        "valueString" : "NamingSystemIdentifierType"
      }],
      "strength" : "required",
      "valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|6.0.0-cibuild"
    }
  },
  {
    "name" : "targetType",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "type" : "code",
    "binding" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
        "valueString" : "NamingSystemIdentifierType"
      }],
      "strength" : "required",
      "valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|6.0.0-cibuild"
    }
  },
  {
    "name" : "preferredOnly",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "If preferredOnly = true then return only the preferred identifier, or if preferredOnly = false then return all available ids.",
    "type" : "boolean"
  },
  {
    "name" : "date",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "If 'date' is supplied return only ids that have a validity period that includes that date.",
    "type" : "dateTime"
  },
  {
    "name" : "result",
    "use" : "out",
    "min" : 1,
    "max" : "1",
    "documentation" : "True if the identifier could be translated successfully.",
    "type" : "boolean"
  },
  {
    "name" : "targetIdentifier",
    "use" : "out",
    "min" : 0,
    "max" : "*",
    "documentation" : "The target identifer(s) of the requested type",
    "type" : "string"
  },
  {
    "name" : "targetIdentifer.preferred",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "Whether the target identifier is preferred.",
    "type" : "boolean"
  },
  {
    "name" : "targetIdentifier.period",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "The perioid when the target identifier is valid.",
    "type" : "Period"
  }]
}

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.