{"version":"https:\/\/jsonfeed.org\/version\/1","title":"Docman Connect Inbound Document Model > Docman Help","home_page_url":"https:\/\/help.docman.com\/knowledge-base\/docman-connect-inbound-document-model\/","feed_url":"https:\/\/help.docman.com\/knowledge-base\/docman-connect-inbound-document-model\/feed\/json","author":{"name":"nextSTL","url":"https:\/\/help.docman.com"},"items":[{"title":"Docman Connect Inbound Document Model","date_published":"2020-07-01T15:26:13Z","date_modified":"2022-05-04T14:03:34Z","id":"https:\/\/help.docman.com\/knowledge-base\/docman-connect-inbound-document-model\/","url":"https:\/\/help.docman.com\/knowledge-base\/docman-connect-inbound-document-model\/","author":{"name":"Oliver Edwards","url":"","avatar":"https:\/\/secure.gravatar.com\/avatar\/916760a3861c94b0f12d9658070815ac6150c9ba5291c9b5304733d70e0fdb9e?s=96&d=mm&r=g"},"summary":"\nIntroduction\n\n\n\nThis article describes the Docman API Inbound Document Model and should be used with the \"Post Document\" method in either the Docman 10 or Docman Connect services in Docman API. The table below explains each field, data type, if the \u2026","content_html":"\n

Introduction<\/h1>\n\n\n\n

This article describes the Docman API Inbound Document Model and should be used with the \"Post Document\" method in either the Docman 10 or Docman Connect services in Docman API. The table below explains each field, data type, if the field is mandatory in either Docman 10 or Docman Connect it also has a small description .<\/p>\n\n\n\n

The model should be built and formatted in a JSON string and included in the body of the \"Post Document\" method. The model is built up with numerous different objects. If the Data type in the inbound document model  is \" X Object\" then \"X Object\" will be described further down the article.<\/p>\n\n\n\n

Inbound Document Model<\/h1>\n\n\n\n
Field<\/td>Type<\/td>Mandatory<\/td>Description<\/td><\/tr>
CaptureSource<\/td>Enum<\/td>

Yes<\/strong><\/p><\/td>

The API capture source for Docman Connect must always be \u20182\u2019<\/p><\/td><\/tr>

Sender<\/td>Sender Object<\/td>

Yes<\/strong><\/p> <\/td>

Object which holds details of the Sender
See Sender Object<\/a><\/em><\/strong><\/td><\/tr>
RecipientOdsCode<\/td>String<\/td>Yes<\/strong><\/strong> <\/td>Connect Endpoint ODS Code

 Max length 10 <\/span><\/p><\/td><\/tr>

Patient<\/td>Patient Object<\/td>

Yes<\/strong><\/p> <\/td>

Object which holds details of the patient
See Patient Object<\/a><\/em><\/strong><\/td><\/tr>
Document<\/td>Document Object<\/td>

Yes<\/strong><\/p> <\/td>

Object which holds the document details and content
See Document Object<\/em><\/a><\/strong><\/td><\/tr>
ActionRequired<\/td>Boolean<\/td>

No<\/strong><\/p> <\/td>

Flag which denotes if the sender deems an action is required or not
Value: <\/strong>True\/False<\/td><\/tr>
MedicationChanged<\/td>Boolean<\/td>

No<\/strong><\/p> <\/td>

Flag which denotes if the medication has changed or not
Value: <\/strong>True\/False<\/td><\/tr>
Urgent<\/td>Boolean<\/td>

No<\/strong><\/p> <\/td>

Flag which denotes if the document is urgent or not
Value: <\/strong>True\/False<\/td><\/tr>
ClinicalCodes<\/td>List \u2013 ClinicalCode Object<\/td>

No<\/strong><\/p> <\/td>

List of ClinicalCode objects which are to be sent into the clinical system
See Clinical Code Object<\/em><\/a><\/strong><\/td><\/tr>
Notes<\/td>String<\/td>

No<\/strong><\/p> <\/td>

Notes from Sender

Max Length: <\/strong>255 <\/span><\/p><\/td><\/tr>

Revision<\/td>Boolean<\/td>No<\/td>Flag which denotes if the document is a revision or not.
Value: <\/strong>True\/False<\/td><\/tr>
MRNNumber<\/td>String<\/td>No<\/td>Medical Record Number (Secondary Patient Identifier\/Hospital Number).
Max length: <\/strong>255<\/td><\/tr>
Inpatient<\/td>Boolean<\/td>No<\/td> Flag which denotes if the document is an inpatient document or not. This is for sending reporting purposes only and this data is not passed to the destination organisation.
Value: <\/strong>True\/False <\/td><\/tr>
Outpatient<\/td>Boolean<\/td>No<\/td> Flag which denotes if the document is an outpatient or not. This is for sending reporting purposes only and this data is not passed to the destination organisation.
Value: <\/strong>True\/False <\/td><\/tr>
OverrideSpineCheck<\/td>Boolean<\/td>No<\/td>Value True overrides the Spine Check. False or excluding the line uses the Spine Check
Value: <\/strong>True\/False<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Document Object<\/span><\/a><\/h2>\n\n\n\n
Field<\/td>Type<\/td>Mandatory<\/td>Description<\/td><\/tr>
Description<\/td>String<\/td> <\/strong> Yes<\/strong> <\/td>Document Description

Max length:<\/strong> 255<\/p><\/td><\/tr>

EventDate<\/td>Date\/Time<\/td>

Yes<\/strong><\/p> <\/td>

Date and Time of the related event.

Date must NOT be in the future<\/p>Format:<\/strong> DateTime ISO 8601 UTC
Example:<\/strong> 2017-11-16T08:53:41.8653032+00:00<\/td><\/tr>

Folder<\/td>String<\/td>

No<\/strong><\/p> <\/td>

Folder description which will be mapped to DM10 folder Id using a case insensitive lookup if a mapping exists

Max length<\/strong>: 50<\/p><\/td><\/tr>

FilingSectionFolder<\/td>String<\/td>No <\/td>Filing folder description which will be mapped to DM10 filing folder Id using a case insensitive lookup if a mapping exists

Max length<\/strong>: 50<\/p><\/td><\/tr>

FileContent<\/td>Byte array<\/td>

Yes<\/strong><\/p> <\/td>

Read the document as Byte array, then convert to Base64 String <\/td><\/tr>
FileExtension<\/td>String<\/td>

Yes<\/strong><\/p> <\/td>

File extension of the Physical File \u2013 the full stop should be omitted but will be removed if present.

Max length:<\/strong> 10<\/p>Allowed formats<\/strong>: html, htm, pdf, rtf, doc, docx, tif, tiff, txt, jpeg, jpg, xps, png<\/td><\/tr>

FileHash<\/td>String<\/td>

No<\/strong><\/p> <\/td>

SHA1 file hash derived from the file content bytes
Max length:<\/strong> 40<\/span>

Optional and will be allocated if omitted<\/p><\/td><\/tr>

ExternalSystemId<\/td>String<\/td>

No<\/strong><\/p> <\/td>

System ID from sending system<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Patient Object<\/span><\/a><\/h2>\n\n\n\n
Field<\/td>Type<\/td>Mandatory<\/td>Description<\/td><\/tr>
Identifier<\/td>String<\/td>Yes<\/strong> <\/td>Patients national identifier \u2013 used as part of patient lookup

Formats:<\/strong> NHS or CHI Number<\/span><\/p>

Validation:<\/strong> MOD11<\/span><\/p>

Max length:<\/strong> 10<\/p><\/td><\/tr>

FamilyName<\/td>String<\/td>

Yes<\/strong><\/p> <\/td>

Surname of patient \u2013 used as part of patient lookup

Max length:<\/strong> 255<\/p> <\/td><\/tr>

GivenNames<\/td>String<\/td>

Yes<\/strong><\/p> <\/td>

Patient\u2019s forenames \u2013 used as part of patient lookup

 Max length:<\/strong> 255<\/p> <\/td><\/tr>

Gender<\/td>Enum \u2013 ePatientGender<\/td>


Yes<\/strong><\/p> <\/td>

Patient\u2019s gender\u2013 used as part of patient lookup
Validation<\/strong>: Against the range of enum values if supplied \u2013 defaults to unknown

Valid Values:<\/p>0 \u2013 Unspecified

10 \u2013 Male<\/p> 20 \u2013 Female <\/td><\/tr>

BirthDate<\/td>Date<\/td>

Yes<\/strong><\/p> <\/td>

DOB of the patient \u2013 used as part of patient lookup
Validation:<\/strong> No future dates
Format:<\/strong> DateTime ISO 8601 UTC
Example:<\/strong> 2017-11-16T08:53:41.8653032+00:00<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Sender Object<\/span><\/a><\/h2>\n\n\n\n
Field<\/td>Type<\/td>Mandatory<\/td>Description<\/td><\/tr>
OdsCode<\/td>String<\/td>

Yes<\/strong><\/p> <\/td>

ODS code of sending organisation

 Max length:<\/strong> 10<\/p><\/td><\/tr>

Organisation<\/td>String<\/td>

Yes<\/strong><\/p> <\/td>

Description of Organisation

Max length:<\/strong> 255<\/span><\/p> <\/td><\/tr>

Department<\/td>String<\/td>

Yes<\/strong><\/p><\/td>

Sending department name

Max length:<\/strong> 255<\/span><\/p><\/td><\/tr>

Person<\/td>String<\/td>

Yes<\/strong><\/p> <\/td>

Person clinically responsible for the document
Max length:<\/strong> 255<\/td><\/tr>
Group<\/td>String<\/td>

No<\/strong><\/p> <\/td>

Name of Sender Group to associate the document with in the Connect Console.
Group must already exist, or it will not be linked to a group.
Max length:<\/strong> <\/span>100<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Clinical Code Object<\/span><\/a><\/h2>\n\n\n\n
<\/div>\n\n\n\n
Field<\/td>Type<\/td>Mandatory<\/td>Description<\/td><\/tr>
Scheme<\/td>Enum \u2013 eCodeScheme<\/td>

Yes<\/strong><\/p><\/td>

Type of coding system. Read 2 or Snomed

Validated against the range of enum values
Accepted Values:<\/strong>
Read = 0
Snomed = 2<\/p><\/td><\/tr>

Code<\/td>String<\/td>\n

Yes<\/strong><\/p>\n <\/td>

Clinical code \u2013 either Read code or Snomed Concept Id<\/td><\/tr>
Description<\/td>String<\/td>\n

Yes<\/strong><\/p>\n <\/td>

Either Read Term or Snomed Description<\/td><\/tr>
DescriptionId<\/td>String<\/td>\n

Yes<\/strong><\/p>\n <\/td>

Either Read TermId or Snomed Description Id<\/td><\/tr>
Value<\/td>String<\/td>\n Conditional<\/strong>
\n (REQUIRED if ValueUnit set)\n <\/td>		Associated clinical value<\/td><\/tr>
ValueUnit<\/td>String<\/td>\n Conditional<\/strong>
\n (REQUIRED if Value set)\n <\/td>		Associated clinical value unit of measure<\/td><\/tr><\/tbody><\/table><\/figure>\n","tags":[]}]}