FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.287  |  FHIR Version 4.0.0  | User: ANONYMOUS (Unknown)  

Resource "NamingSystem-preferred-id" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Fetch Preferred it

OPERATION: Fetch Preferred it

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id

This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters:

  • a system identifier - either a URI, an OID, or a v2 table 0396 (other) code
  • a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier)

and returns either the requested identifier, or an HTTP errors response with an OperationOutcome because either the provided identifier was not recognized, or the requested identiifer type is not known.

The principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.

URL: [base]/NamingSystem/$preferred-id

Parameters

Use Name Cardinality Type Binding Documentation
IN id 1..1 string

The server parses the provided id to see what type it is (mary 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

IN type 1..1 code http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.0 (Required)
OUT result 1..1 string

OIDs are return as plain OIDs (not the URI form).

Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type ( NamingSystem.uniqueId.type). If there are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error.

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


{
  "resourceType" : "OperationDefinition",
  "id" : "NamingSystem-preferred-id",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:44.129Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Fetch Preferred it</h2>\n <p>OPERATION: Fetch Preferred it</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id</pre>\n <div>\n <p>This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters:</p>\n\n <ul>\n\n <li>a system identifier - either a URI, an OID, or a v2 table 0396 (other) code</li>\n\n <li>a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier)</li>\n\n </ul>\n\n <p>and returns either the requested identifier, 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>\n\n <p>The principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.</p>\n\n </div>\n <p>URL: [base]/NamingSystem/$preferred-id</p>\n <p>Parameters</p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Use</b>\n </td>\n <td>\n <b>Name</b>\n </td>\n <td>\n <b>Cardinality</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Binding</b>\n </td>\n <td>\n <b>Documentation</b>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>id</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The server parses the provided id to see what type it is (mary 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\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>type</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#code\">code</a>\n </td>\n <td>\n <a href=\"valueset-namingsystem-identifier-type.html\">http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.0</a> (Required)\n </td>\n <td/>\n </tr>\n <tr>\n <td>OUT</td>\n <td>result</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td>\n <div>\n <p>OIDs are return as plain OIDs (not the URI form).</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div>\n <p>Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (\n <a href=\"namingsystem-definitions.html#NamingSystem.uniqueId.type\">NamingSystem.uniqueId.type</a>). If there are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error.\n </p>\n\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\n </div>\n </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/OperationDefinition/NamingSystem-preferred-id",
  "version" : "4.0.0",
  "name" : "Fetch Preferred it",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2018-12-14T01:14:32+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/fhir"
        },
        {
          "system" : "email",
          "value" : "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters: \n\n* a system identifier - either a URI, an OID, or a v2 table 0396 (other) code \n* a code for what kind of identifier is desired (URI, OID, v2 table 0396 identifier) \n\nand returns either the requested identifier, or an HTTP errors response with an OperationOutcome because either the provided identifier was not recognized, or the requested identiifer type is not known. \n\nThe principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.",
  "code" : "preferred-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)). If there are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error. \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 id to see what type it is (mary 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" : "type",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.0"
      }
    },
    {
      "name" : "result",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "OIDs are return as plain OIDs (not the URI form).",
      "type" : "string"
    }
  ]
}