Table 1.
HL7 IB example request implemented as a URL. The name of the parameter appears after an ampersand (‘&’) and the value after an equals sign (‘=’). The role of each component of the example is explained to the right. Object Identifiers (OIDs), are globally unique identifiers set by the International Organization for Standardization (ISO) and used by HL7 to identify organizations and code systems. Note: more parameters are in the HL7 IB specification.
| Example of Infobutton Request Syntax | Explanation of Component |
|---|---|
| http://clingen.org/tools-resources/web-resources/?searchType=HL7 | Base URL of knowledge resource |
| &representedOrganization.id.root=1.3.6.1.4.1.3768 | OID of requesting organization |
| &patientPerson.administrativeGenderCode.c=F | Patient gender (code) |
| &age.v.v=67 | Patient age (value) |
| &age.v.u=a | Patient age (units) |
| &mainSearchCriteria.v.c=749196 | Search term (code) |
| &mainSearchCriteria.v.cs=2.16.840.1.113883.6.88 | Search term (OID of code system) |
| &mainSearchCriteria.v.dn=Clopidogrel | Search term (display name) |
| &performer=PROV | Role of person performing request (code) |
| &taskContext.c.c=MLREV | Context of the EHR task (code) |
| &informationRecipient=PROV | Role of person consuming results (code) |
| &knowledgeResponseType=application/json | Defines syntax of response |