Annotated StoredQuery Transaction
Jump to navigation
Jump to search
Annotated StoredQuery Transaction
What follows is the metadata for a Stored Query transaction as generated by a Document Consumer actor. All the XML shown, when combined, makes a valid request. This example was generated with the testing tool xdstest using testkit test 11897/objectref.
The Stored Query transaction is always carried in a SOAP over HTTP packaged formatted with SIMPLE SOAP rules. An example showing the SOAP and HTTP is found here.
The outer-most wrapper is AdhocQueryRequest which contains two elements, ResponseOption and AdhocQuery.
<query:AdhocQueryRequest xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0" xmlns="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0">
The ResponseOption controls the type of content returned from the Registry. The attributes are:
- returnType="ObjectRef" - returnType must have one of two values: ObjectRef or LeafClass.
- ObjectRef returns ObjectRefs which are simple a list of UUIDs of registry objects (Document Entries, Submission Sets, Folders, Associations) that match the query.
- LeafClass returns the full metadata describing the matched registry objects. Full metadata means all the attributes submitted in a Provide and Register transaction along with some others controlled and generated by the Registry. If your query matches a large number of registry objects this format can generate really large blocks of XML.
<query:ResponseOption returnComposedObjects="true" returnType="ObjectRef"/> <AdhocQuery id="urn:uuid:14d4debf-8f97-4251-9a74-a90016b0af0d"> <Slot name="$XDSDocumentEntryPatientId"> <ValueList> <Value>'144ba3c4aad24e9^^^&1.3.6.1.4.1.21367.2005.3.7&ISO'</Value> </ValueList> </Slot> <Slot name="$XDSDocumentEntryStatus"> <ValueList> <Value>('urn:oasis:names:tc:ebxml-regrep:StatusType:Approved', 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated')</Value> </ValueList> </Slot> </AdhocQuery> </query:AdhocQueryRequest>