NamingSystem Resource

The FHIR NamingSystem resource is used to represent a naming or identification system that provides unique identifiers for healthcare resources. Within AdvaPACS, NamingSystem resources correspond to configured Assigning Authorities. These NamingSystems provide a FHIR system URI that can be used when declaring identifiers in other FHIR resources, allowing identifiers to be associated with the appropriate Assigning Authority.

For full information on the NamingSystem resource, please refer to the FHIR standard.

Note

NamingSystem resources are available when Assigning Authorities are enabled for the AdvaPACS tenant.

Supported Transactions

AdvaPACS supports the following transactions for the NamingSystem resource:

Function	Method	Endpoint	Description
Get NamingSystem	GET	/NamingSystem/{id}	Retrieves a specific NamingSystem resource by its logical ID.
Search NamingSystems	GET	/NamingSystem	Searches for NamingSystem resources matching the supplied search parameters.

Examples

The following examples show how to retrieve and search for NamingSystem resources using the AdvaPACS FHIR API. These examples demonstrate how Assigning Authorities are represented as FHIR NamingSystem resources and how their FHIR system URI can be used when declaring identifiers in other resources.

Get a NamingSystem

A specific NamingSystem can be retrieved using the logical ID assigned to the resource. The response contains information about the corresponding AdvaPACS Assigning Authority, including its name and the identifiers used to represent it in HL7 v2 and FHIR.

GET /fhir/R5/NamingSystem/[NamingSystem_ID]
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

For example, to retrieve a NamingSystem with logical ID 99e3ef1f-67f4-4243-a77f-525c98834886:

GET /fhir/R5/NamingSystem/99e3ef1f-67f4-4243-a77f-525c98834886
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns the requested NamingSystem resource:

{
  "resourceType": "NamingSystem",
  "id": "99e3ef1f-67f4-4243-a77f-525c98834886",
  "name": "NATIONAL_ID",
  "status": "active",
  "kind": "identifier",
  "date": "2022-12-26T07:26:49+00:00",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code": "PN"
      }
    ]
  },
  "uniqueId": [
    {
      "type": "other",
      "value": "NATIONAL_ID",
      "comment": "HL7 V2"
    },
    {
      "type": "uri",
      "value": "https://sgp.api.integration.advapacs.com/fhir/NamingSystem/99e3ef1f-67f4-4243-a77f-525c98834886",
      "comment": "FHIR System"
    }
  ]
}

The uniqueId elements identify the values used to represent the Assigning Authority in different interfaces. The entry with the FHIR System comment provides the system URI that can be used when declaring identifiers in other FHIR resources.

For example:

{
  "system": "https://sgp.api.integration.advapacs.com/fhir/NamingSystem/99e3ef1f-67f4-4243-a77f-525c98834886",
  "value": "123456"
}

Search NamingSystems

NamingSystem resources can be searched using supported FHIR search parameters. One or more parameters can be included in the request to narrow the NamingSystems returned by the FHIR API.

The following search parameters are supported:

Parameter	Description	Example
_id	Search by the logical FHIR resource ID.	?_id=99e3ef1f-67f4-4243-a77f-525c98834886
name	Search by the NamingSystem name.	?name=NATIONAL_ID
status	Search by the NamingSystem status.	?status=active
kind	Search by the NamingSystem kind.	?kind=identifier
value	Search by a unique identifier associated with the NamingSystem.	?value=NATIONAL_ID

For example, to search for the NATIONAL_ID NamingSystem:

GET /fhir/R5/NamingSystem?name=NATIONAL_ID
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns a FHIR search Bundle containing the matching NamingSystem resources:

{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "resource": {
        "resourceType": "NamingSystem",
        "id": "99e3ef1f-67f4-4243-a77f-525c98834886",
        "name": "NATIONAL_ID",
        "status": "active",
        "kind": "identifier",
        "date": "2022-12-26T07:26:49+00:00",
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
              "code": "PN"
            }
          ]
        },
        "uniqueId": [
          {
            "type": "other",
            "value": "NATIONAL_ID",
            "comment": "HL7 V2"
          },
          {
            "type": "uri",
            "value": "https://sgp.api.integration.advapacs.com/fhir/NamingSystem/99e3ef1f-67f4-4243-a77f-525c98834886",
            "comment": "FHIR System"
          }
        ]
      }
    }
  ]
}

Multiple search parameters can be combined to further narrow the results. For example, to return active NamingSystems of the identifier kind:

GET /fhir/R5/NamingSystem?status=active&kind=identifier
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>