Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.11.11.2 Operation $translate-id on NamingSystem

FHIR Infrastructure Work Group Maturity Level: 1Trial Use Compartments: N/A

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.

The official URL for this operation definition is

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

Formal Definition (as a OperationDefinition).

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

This is an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
id1..1string

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

sourceType1..1codeNamingSystemIdentifierType (Required)
targetType1..1codeNamingSystemIdentifierType (Required)
preferredOnly0..1boolean

If preferredOnly = true then return only the preferred identifier, or if preferredOnly = false then return all available ids.

date0..1dateTime

If 'date' is supplied return only ids that have a validity period that includes that date.

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
result1..1boolean

True if the identifier could be translated successfully.

targetIdentifier0..*boolean

The target identifer(s) of the requested type

targetIdentifer.preferred0..1boolean

Whether the target identifier is preferred.

targetIdentifier.period0..1boolean

The perioid when the target identifier is valid.

Servers handle this request by finding the provided identifier in their known naming systems, and returning the requested identifier type (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

4.11.11.2.1 Examples

Request: Using POST

GET [base]/NamingSystem/$translate-id?id=1.2.36.1.2001.1003.0&sourceType=oid&targetType=uri&preferredOnly=true

--------------------------------------
POST [base]/NamingSystem/$translate-id
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [ {
     "name" : "id",
     "valueString" : "1.2.36.1.2001.1003.0"
   }, {
     "name" : "sourceType",
     "valueCode" : "oid"
   }, {
     "name" : "targetType",
	 "valueCode : "uri"
   }, {
     "name" : "preferredOnly",
	 "valueboolean" : "true"
   }
  ]
}

Response:

HTTP/1.1 200 OK
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [ {
     "name" : "targetIdentifier",
     "valueString" : "http://ns.electronichealth.net.au/id/hi/ihi/1.0"
   }, {
     "name" : "targetIdentifier.preferred",
	 "valueBoolean" : "true"
   }
  ]
}

 

For more information about operations, including how they are invoked, see Operations.