Release 5 Draft Ballot

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

Operation-namingsystem-translate-id

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

translate-id

OPERATION: translate-id

The official URL for this operation definition is: 

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

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.

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INid1..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

INsourceType1..1codehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.6.0|4.6.0 (Required)
INtargetType1..1codehttp://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.6.0|4.6.0 (Required)
INpreferredOnly0..1boolean

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

INdate0..1dateTime

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

OUTresult1..1boolean

True if the identifier could be translated successfully.

OUTtargetIdentifier0..*boolean

The target identifer(s) of the requested type

OUTtargetIdentifer.preferred0..1boolean

Whether the target identifier is preferred.

OUTtargetIdentifier.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

 

 

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.