Pacs Query

Description

This module provides a URL-based query to a PACS system, retrieving studies according to patient ID and returning a list of matched studies with a collection of queried fields.

The connection to the PACS system should be configured via the pacsquery.pacsConfig OpenMRS globalProperty. Studies can be retrieved by going to http://HOSTIP/openmrs/ws/rest/v1/pacs/studies?patientId=GAN203006. Fields can be configured using the pacsquery.retrieveTags globalProperty.

The response JSON is an array of FHIR ImagingStudy of minimal representation.

Example:

[
    {
        "resourceType": "ImagingStudy",
        "id": "1.3.6.1.4.1.5962.99.1.2594.1780.1630387530609.1.2.0",
        "identifier": [
            {
                "system": "urn:dicom:uid",
                "value": "urn:oid:1.3.6.1.4.1.5962.99.1.2594.1780.1630387530609.1.2.0"
            },
            {
                "system": "urn:bahmni:accession",
                "value": "urn:oid:ORD-308"
            }
        ],
        "subject": {
            "reference": "Patient/GAN203006"
        },
        "started": "20210831105530",
        "status": "available"
    },
    {
        "resourceType": "ImagingStudy",
        "id": "1.3.6.1.4.1.5962.99.1.2595.1980.1630388022378.1.2.0",
        "identifier": [
            {
                "system": "urn:dicom:uid",
                "value": "urn:oid:1.3.6.1.4.1.5962.99.1.2595.1980.1630388022378.1.2.0"
            },
            {
                "system": "urn:bahmni:accession",
                "value": "urn:oid:ORD-307"
            }
        ],
        "subject": {
            "reference": "Patient/GAN203006"
        },
        "started": "20210831110342",
        "status": "available"
    }
]

Building from Source

This module was created using the OpenMRS SDK.

Full build instructions

You will need to have Java 1.8+ and Maven 2.x+ installed. Use the command 'mvn package' to compile and package the module. The .omod file will be in the omod/target folder.

Alternatively you can add the snippet provided in the Creating Modules page to your omod/pom.xml and use the mvn command:

mvn package -P deploy-web -D deploy.path="../../openmrs-1.8.x/webapp/src/main/webapp"

It will allow you to deploy any changes to your web resources such as jsp or js files without re-installing the module. The deploy path says where OpenMRS is deployed.

Installation

1. Build the module to produce the .omod file.
2. Use the OpenMRS Administration > Manage Modules screen to upload and install the .omod file.

If uploads are not allowed from the web (changable via a runtime property), you can drop the omod into the ~/.OpenMRS/modules folder. (Where ~/.OpenMRS is assumed to be the Application Data Directory that the running openmrs is currently using.) After putting the file in there simply restart OpenMRS/tomcat and the module will be loaded and started.