gov.nist.toolkit.toolkitApi

Interface DocumentRegRep

All Superinterfaces:

AbstractActorInterface, SimConfig, SimId

public interface DocumentRegRep
extends AbstractActorInterface

Method Summary

Modifier and Type	Method and Description
RefList	findDocumentsForPatientID(java.lang.String patientID) This is the equivalent of a FindDocuments Stored Query.
java.lang.String	getDocEntry(java.lang.String uuid) Get full metadata (XML) for a DocumentEntry
DocumentContent	getDocument(java.lang.String uniqueId) Get contents of a document

Methods inherited from interface gov.nist.toolkit.toolkitApi.AbstractActorInterface

asBoolean, asString, delete, describe, getConfig, getEvent, getEventIds, getId, isBoolean, setProperty, setProperty, update

Methods inherited from interface gov.nist.toolkit.toolkitServicesCommon.SimConfig

asList, getPatientErrorMap, getPropertyNames, isList, isString, setPatientErrorMap, setProperty

Methods inherited from interface gov.nist.toolkit.toolkitServicesCommon.SimId

getActorType, getEnvironmentName, getFullId, getUser, isFhir

Method Detail

findDocumentsForPatientID

RefList findDocumentsForPatientID(java.lang.String patientID)
                           throws ToolkitServiceException

This is the equivalent of a FindDocuments Stored Query.

Parameters:

patientID - - full patient id with Assigning Authority

Returns:

list of model references - UUIDs of the DocumentEntries

Throws:

ToolkitServiceException

getDocEntry

java.lang.String getDocEntry(java.lang.String uuid)
                      throws ToolkitServiceException

Get full metadata (XML) for a DocumentEntry

Parameters:

uuid - - UUID of a DocumentEntry

Returns:

full XML metadata for ExtrinsicObject representing DocumentEntry

Throws:

ToolkitServiceException

getDocument

DocumentContent getDocument(java.lang.String uniqueId)
                     throws ToolkitServiceException

Get contents of a document

Parameters:

uniqueId - - DocumentEntry.uniqueId

Returns:

contents of the document

Throws:

ToolkitServiceException