This transaction is used by the Document Source actor to provide one or more documents to the IHE XDS Document Repository along with the metadata that describes the document and which will be stored in the IHE XDS Document Registry.
The Document Source will send both the document data and the metadata to the Document Repository actor, the Document Repository will store the document data and forwards the metadata to the Document Registry which handles their persistence.
The Provide and Register Document Set-b transaction supports the following data:
After recieving a Provide and Register Document Set-b transaction, the Document Repository will send a Register Document Set-b transaction to the Document Registry actor:
Each document within the message is stored into the Document Repository as an octet stream with an associated MIME type. The Document Repository modifies the received document metadata before initiating the Register Document Set-b transaction to the Document Registry by adding/replacing:
A Document Source that submits a document via the Provide and Register Document Set-b transaction supports the following options:
There is no need for the Document Source to do a seperate Register Document Set-b [ITI-42] transaction.
For more information about the provide & register Document Set-b please see IHE IT Infrastructure Technical Framework Volume 2b (ITI TF-2b) on page 154 - 164
The example message below is generated using the XDStarClient(https://gazelle.ehealth.brussels/XDStarClient) and contains metadata and a link to the (CDA) ReferralSummary document:
Please mind that the metadata and clinical data in the ReferallSummary is (partly) generated and therefore not necessarily coherent.
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing"
xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
<a:Action s:mustUnderstand="1">urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b</a:Action>
<a:MessageID>urn:uuid:1036b3a8-9fb7-4ba2-8fa5-ff20fa69174a</a:MessageID>
<a:ReplyTo>
<a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
</a:ReplyTo>
<a:To s:mustUnderstand="1">https://api.qa.brusafe.be:8003/services/repository-noxua</a:To>
</s:Header>
<s:Body>
<xdsb:ProvideAndRegisterDocumentSetRequest xmlns:lcm="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0"
xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0"
xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
xmlns:xdsb="urn:ihe:iti:xds-b:2007"
xmlns:xop="http://www.w3.org/2004/08/xop/include">
<lcm:SubmitObjectsRequest>
<rim:RegistryObjectList>
<rim:RegistryPackage id="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:RegistryPackage">
<rim:Slot name="submissionTime">
<rim:ValueList>
<rim:Value>20170327110519</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="XDS Submission Set"/>
</rim:Name>
<rim:Classification classificationScheme="urn:uuid:aa543740-bdda-424e-8c96-df4873be8500"
classifiedObject="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
id="urn:uuid:5dd36898-11a4-4587-9247-90304397a0fa"
nodeRepresentation="371531000"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>2.16.840.1.113883.6.96</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="medisch consultverslag"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationNode="urn:uuid:a54d6aa5-d40d-43f9-88c5-b4633d873bdd"
classifiedObject="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
id="urn:uuid:f2e10793-86ad-4406-bad6-95c7a32b4065"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification"/>
<rim:ExternalIdentifier id="urn:uuid:b204cdd8-352d-480e-b918-9f6104c4721a"
identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"
registryObject="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
value="1.3.6.1.4.1.21367.2016.1.1">
<rim:Name>
<rim:LocalizedString value="XDSSubmissionSet.sourceId"/>
</rim:Name>
</rim:ExternalIdentifier>
<rim:ExternalIdentifier id="urn:uuid:2af9fb5c-ff13-40cf-9a5b-7274c1d7c1fc"
identificationScheme="urn:uuid:96fdda7c-d067-4183-912e-bf5ee74998a8"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"
registryObject="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
value="1.3.6.1.4.1.12559.11.26.4.3.1002">
<rim:Name>
<rim:LocalizedString value="XDSSubmissionSet.uniqueId"/>
</rim:Name>
</rim:ExternalIdentifier>
<rim:ExternalIdentifier id="d92299e7-2ea7-4c46-ab67-f783940d5a86"
identificationScheme="urn:uuid:6b5aea1a-874d-4603-a4bc-96a0a7b38446"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"
registryObject="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
value="99010100118^^^&1.3.6.1.4.1.21297.100.1.1&ISO">
<rim:Name>
<rim:LocalizedString value="XDSSubmissionSet.patientId"/>
</rim:Name>
</rim:ExternalIdentifier>
</rim:RegistryPackage>
<rim:ExtrinsicObject id="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
mimeType="text/xml"
objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1"
status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved">
<rim:Slot name="languageCode">
<rim:ValueList>
<rim:Value>en-us</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="creationTime">
<rim:ValueList>
<rim:Value>20170327110332</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="sourcePatientId">
<rim:ValueList>
<rim:Value>99010100118^^^&1.3.6.1.4.1.21297.100.1.1&ISO</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Testdocument"/>
</rim:Name>
<rim:Classification classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:c71c0c36-63ba-4a41-b275-3cc99d91bee6"
nodeRepresentation="9541000146104"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>2.16.840.1.113883.6.96</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="MRI-documentatie"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationScheme="urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:76dc88f0-76bb-44ac-aea7-01f3ee342f16"
nodeRepresentation="N"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>2.16.840.1.113883.5.25</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Normal"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationScheme="urn:uuid:a09d5840-386c-46f2-b5ad-9c3699a4309d"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:2d30662a-0368-4a10-8989-20de298f22d4"
nodeRepresentation="urn:ihe:pcc:xds-ms:2007"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>1.3.6.1.4.1.19376.1.2.3</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Medical Summary"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:6d4a8fa3-c721-49d0-9ef6-fa2a37aebf7b"
nodeRepresentation="V4"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>2.16.840.1.113883.2.4.15.1060</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Ziekenhuis"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:416a4a05-64ee-4fb6-8b71-e2dfad302a3e"
nodeRepresentation="309902002"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>2.16.840.1.113883.6.96</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Clinical oncology department"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-c59651d33983"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:ecc9315d-c845-4d1a-9b07-822ad4f955b0"
nodeRepresentation="10781000146107"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>2.16.840.1.113883.6.96</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="angiografieverslag"/>
</rim:Name>
</rim:Classification>
<rim:Classification classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d"
classifiedObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
id="urn:uuid:6d362b8e-9043-4409-b5d3-42cf1aa385a6"
nodeRepresentation="888882"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:Classification">
<rim:Slot name="authorPerson">
<rim:ValueList>
<rim:Value>888882^Wiseman^Bernard^^Sr.^Dr.^^^&1.3.5.35.1.4436.7&ISO</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="XDSDocumentEntry.author"/>
</rim:Name>
</rim:Classification>
<rim:ExternalIdentifier id="urn:uuid:af3e42c9-d88e-475c-b53b-e2cd29716f5d"
identificationScheme="urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"
registryObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
value="1.3.6.1.4.1.12559.11.26.4.2.1003">
<rim:Name>
<rim:LocalizedString value="XDSDocumentEntry.uniqueId"/>
</rim:Name>
</rim:ExternalIdentifier>
<rim:ExternalIdentifier id="fcfcac2d-5cc3-4edd-99cd-4b9bff178854"
identificationScheme="urn:uuid:58a6f841-87b3-4a3e-92fd-a8ffeff98427"
objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"
registryObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"
value="99010100118^^^&1.3.6.1.4.1.21297.100.1.1&ISO">
<rim:Name>
<rim:LocalizedString value="XDSDocumentEntry.patientId"/>
</rim:Name>
</rim:ExternalIdentifier>
</rim:ExtrinsicObject>
<rim:Association associationType="urn:oasis:names:tc:ebxml-regrep:AssociationType:HasMember"
id="dc88939d-fdeb-4403-8234-106dbd8990a5"
sourceObject="urn:uuid:907f6175-7536-4cd3-83e7-e5455796e56b"
targetObject="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961">
<rim:Slot name="SubmissionSetStatus">
<rim:ValueList>
<rim:Value>Original</rim:Value>
</rim:ValueList>
</rim:Slot>
</rim:Association>
</rim:RegistryObjectList>
</lcm:SubmitObjectsRequest>
<xdsb:Document id="urn:uuid:a351fbd3-1da0-40ca-abac-3c4c4f0ac961"><xop:Include href="cid:1.urn:uuid:A351FBD31DA040CAABAC3C4C4F0AC961@ws.jboss.org"/></xdsb:Document>
</xdsb:ProvideAndRegisterDocumentSetRequest>
</s:Body>
</s:Envelope> |
Documentation for this transaction will be made available when the MHD Recipient will be released.