Docman Connect Inbound Document Model

Introduction

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 .

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.

Inbound Document Model

Field

Type

Mandatory

Description

CaptureSource

Enum

Yes

The API capture source for Docman Connect must always be ‘2’

Sender

Sender Object

Yes

Object which holds details of the SenderSee Sender Object

RecipientOdsCode

String

Yes

Connect Endpoint ODS Code

Patient

Patient Object

Yes

Object which holds details of the patientSee Patient Object

Document

Document Object

Yes

Object which holds the document details and contentSee Document Object

ActionRequired

Boolean

No

Flag which denotes if the sender deems an action is required or notValue: True/False

MedicationChanged

Boolean

No

Flag which denotes if the medication has changed or notValue: True/False

Urgent

Boolean

No

Flag which denotes if the document is urgent or notValue: True/False

ClinicalCodes

List – ClinicalCode Object

No

List of ClinicalCode objects which are to be sent into the clinical systemSee Clinical Code Object

Notes

String

No

Notes from Sender

Revision

Boolean

No

Flag which denotes if the document is a revision or not.Value: True/False

MRNNumber

String

No

Medical Record Number (Secondary Patient Identifier/Hospital Number).Max length: 255

Inpatient

Boolean

No

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: True/False

Outpatient

Boolean

No

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: True/False

OverrideSpineCheck

Boolean

No

Value True overrides the Spine Check. False or excluding the line uses the Spine CheckValue: True/False

Document Object

Field

Type

Mandatory

Description

Description

String

  Yes

Document Description

EventDate

Date/Time

Yes

Date and Time of the related event.Format: DateTime ISO 8601 UTCExample: 2017-11-16T08:53:41.8653032+00:00

Folder

String

No

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

FilingSectionFolder

String

No

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

FileContent

Byte array

Yes

Read the document as Byte array, then convert to Base64 String

FileExtension

String

Yes

File extension of the Physical File – the full stop should be omitted but will be removed if present.Allowed formats: html, htm, pdf, rtf, doc, docx, tif, tiff, txt, jpeg, jpg, xps, png

FileHash

String

No

SHA1 file hash derived from the file content bytesMax length: 40

ExternalSystemId

String

No

System ID from sending system

Patient Object

Field

Type

Mandatory

Description

Identifier

String

Yes

Patients national identifier – used as part of patient lookup

FamilyName

String

Yes

Surname of patient – used as part of patient lookup

GivenNames

String

Yes

Patient’s forenames – used as part of patient lookup

Gender

Enum – ePatientGender

Yes

Patient’s gender– used as part of patient lookupValidation: Against the range of enum values if supplied – defaults to unknown0 – Unspecified20 – Female

BirthDate

Date

Yes

DOB of the patient – used as part of patient lookupValidation: No future datesFormat: DateTime ISO 8601 UTCExample: 2017-11-16T08:53:41.8653032+00:00

Sender Object

Field

Type

Mandatory

Description

OdsCode

String

Yes

ODS code of sending organisation

Organisation

String

Yes

Description of Organisation

Department

String

Yes

Sending department name

Person

String

Yes

Person clinically responsible for the documentMax length: 255

Group

String

No

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: 100

Clinical Code Object

Field

Type

Mandatory

Description

Scheme

Enum – eCodeScheme

Yes

Type of coding system. Read 2 or SnomedValidated against the range of enum valuesAccepted Values:Read = 0Snomed = 2

Code

String

Yes

Clinical code – either Read code or Snomed Concept Id

Description

String

Yes

Either Read Term or Snomed Description

DescriptionId

String

Yes

Either Read TermId or Snomed Description Id

Value

String

Conditional(REQUIRED if ValueUnit set)

Associated clinical value

ValueUnit

String

Conditional(REQUIRED if Value set)

Associated clinical value unit of measure

Updated on May 4, 2022

How did we do?

Connect Printer Drivers

Contact