Concept Reference Term API

Structure of the data

The URL for fetching the concept reference term published through the Atom Feed is /openmrs/ws/rest/v1/conceptreferenceterm/a580061a-2e3b-4936-b232-cb5c2ec308fd?v=custom:(uuid,name,conceptSource,description,code,version,retired,conceptReferenceTermMaps). Using this URL, a concept reference term could be fetched from the TR server. 

The following listing shows a sample concept reference term fetched using the url mentioned above. 

<?xml version="1.0" encoding="UTF-8"?>
<object>
 <uuid>a580061a-2e3b-4936-b232-cb5c2ec308fd</uuid>
 <name>Viral pneumonia 206925</name>
 <conceptSource>
     <uuid>30601597-21d1-4bcd-a617-71955219276b</uuid>
     <display>ICD10-BD</display>
     <name>ICD10-BD</name>
     <description>ICD10 Codes for Bangladesh</description>
     <hl7Code>ICD10-BD</hl7Code>
     <retired>false</retired>
     <links>
       <link>
         <rel>self</rel>
         <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptsource/30601597-21d1-4bcd-a617-71955219276b</uri>
       </link>
     <link>
       <rel>full</rel>
       <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptsource/30601597-21d1-4bcd-a617-71955219276b?v=full</uri>
     </link>
    </links>
   <resourceVersion>1.8</resourceVersion>
 </conceptSource>
 <description>Viral pneumonia, unspecified Excl.: 206925</description>
 <code>J19.206925</code>
 <version>1.0</version>
 <retired>false</retired>

 <conceptReferenceTermMaps>

    <conceptreferencetermmap>
      <uuid>9ed7304e-ebe0-4d48-94b4-a4c2cc0b2c80</uuid>
      <display>ICD10-BD: J19.600148 - ICD10-BD: B00</display>
      <termA>
        <uuid>8053f717-5b7c-484e-81bf-7d3e577fbefd</uuid>
        <display>ICD10-BD: J19.600148 (IViral pneumonia, unspecified)</display>
        <links>
          <link>
            <rel>self</rel>
            <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptreferenceterm/8053f717-5b7c-484e-81bf-7d3e577fbefd</uri>
          </link>
        </links>
      </termA>
      <termB>
        <uuid>f8145ea8-4d68-4cce-8eed-2ec9232377a6</uuid>
        <display>ICD10-BD: B00 (Herpesviral Infection)</display>
        <links>
          <link>
             <rel>self</rel>
             <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptreferenceterm/f8145ea8-4d68-4cce-8eed-2ec9232377a6</uri>
          </link>
       </links>
     </termB>
     <conceptMapType>
        <uuid>35543629-7d8c-11e1-909d-c80aa9edcf4e</uuid>
        <display>SAME-AS</display>
        <links>
          <link>
            <rel>self</rel>
            <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptmaptype/35543629-7d8c-11e1-909d-c80aa9edcf4e</uri>
          </link>
       </links>
    </conceptMapType>
    <links>
      <link>
        <rel>self</rel>
        <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptreferencetermmap/9ed7304e-ebe0-4d48-94b4-a4c2cc0b2c80</uri>
      </link>
      <link>
        <rel>full</rel>
        <uri>http://172.18.46.53:9080/openmrs/ws/rest/v1/conceptreferencetermmap/9ed7304e-ebe0-4d48-94b4-a4c2cc0b2c80?v=full</uri>
     </link>
    </links>
    <resourceVersion>1.9</resourceVersion>
   </conceptreferencetermmap>
 </conceptReferenceTermMaps>

</object>

Field description

• uuid: A unique identifier that refers to the concept reference term in the server
• name: A human readable name for the concept reference term
• description: A human readable description for the concept reference term
• code: A string that specifies the code that refers to the concept reference term uniquely in any coding system
• version: The current version of the concept reference term 
• retried: Whether the concept reference term is retired or not.