The XDS Delivery Option allows delivery of Notes to a XDS compatible endpoint.
URL: The url of the endpoint that accepts SaveDocument requests.
HTTP Version: Some receiving systems may require a specific HTTP version be used, you can specify HTTP 1.0 or 1.1 here.
Format: Format of the delivered document, HTML or PDF.
Text Encoding: Text encoding used for HTML formatted deliveries.
Output Style: Whether the document is rendered in standard size, or compact size.
Grouped: Whether notes with same group category are delivered as a monthly bundle.
Group Category: Category used to generated the unique identifier for a grouped document set.
Document Template: A template of the XML body of the POST to the XDS endpoint. This template can include contextual variables relating to the note it is delivering:
Variable Key | Description |
document.author.multiple_authors | Boolean indicating if this delivery is grouped, and therefore has multiple authors. |
document.author.first_name | String of the document's signing author's first name. Not included if multiple_authors is true. |
document.author.last_name | String of the document's signing author's last name. Not included if multiple_authors is true. |
patient.external_id | String of the external id of the patient this note, or group of notes is related to. |
id | String a generated id used to uniquely identify this note, or note group. |
date | String representing the signing date of the note, or applicable date for the note group. |
workflow.name | String of the name of the workflow. |
workflow.delivey_properties.<property key> | String of the value of the associated <property key> defined in the workflow's "Delivery Properties" section. |
| mimeType | String representing the MIME Type of the content based on the delivery option format set (text/html or application/pdf) |
| contents | String of the HTML or Base64 encoded PDF data, based on the delivery option format set. |
Eg:
<?xml version='1.0' encoding='UTF-8'?>
<soap12:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xmlns:ns0='ihetoolkit.orionhealth.com'
xmlns:soap12='http://www.w3.org/2003/05/soap-envelope'>
<soap12:Body><ns0:SaveDocument>
<ProvideAndRegisterDocumentSet xmlns='http://www.orionhealth.com/2011/08/ihe' sourceId='2.16.840.1.113883.2.18.69.3.1.4'>
<Comments></Comments>
<Author>
<Person assigningAuthority='2.16.840.1.113883.2.18.69.10.7' id='2.16.840.1.113883.2.18.69.10.7.12' givenName='Rhapsody IHE Toolkit Hub' familyName='Rhapsody IHE Toolkit Hub' />
</Author>
<ContentTypeCode codingSystem='CDHB' description='Clinical Documents' value='CD'/>
<PatientId assigningAuthority='2.16.840.1.113883.2.18.2' id='{{patient.external_id}}'/>
<Document
uniqueId='2.16.840.1.113883.2.18.69.10.7.12.{{id}}'
creationTime='{{date}}'
serviceStartTime='{{date}}'
serviceStopTime='{{date}}'
languageCode='en'
mimeType='{{mimeType}}'
title='{{workflow.name}}'>
<Author>
<Person assigningAuthority='2.16.840.1.113883.2.18.3.3' id='G00005' familyName='Cortex'/>
<Institution id='F04028' universalId='2.16.840.1.113883.2.18.3.2' name='Christchurch Hospital' />
<Institution id='G00005' universalId='2.16.840.1.113883.2.18.3.3' name='Canterbury District Health Board' />
</Author>
<ClassCode codingSystem='2.16.840.1.113883.2.18.69.10.1' value='CD' description='Clinical Documents' />
<ConfidentialityCode codingSystem='2.16.840.1.113883.5.25' value='N' description='Normal' />
<FormatCode codingSystem='2.16.840.1.113883.2.18.69.10.4' value='TEXT' description='Textual Document' />
<HealthcareFacilityTypeCode codingSystem='2.16.840.1.113883.2.18.69.10.5' value='01' description='Public Hospital' />
<PracticeSettingCode codingSystem='2.16.840.1.113883.2.18.69.10.6' value='M85' description='Other Medical Services' />
<TypeCode codingSystem='2.16.840.1.113883.2.18.69.10.2' value='PRO' description='Progress' />
<DocumentContents>{{contents}}</DocumentContents>
</Document>
</ProvideAndRegisterDocumentSet>
</ns0:SaveDocument></soap12:Body>
</soap12:Envelope>