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 Sender See Sender Object
RecipientOdsCode	String	Yes	Connect Endpoint ODS Code  Max length 10
Patient	Patient Object	Yes	Object which holds details of the patient See Patient Object
Document	Document Object	Yes	Object which holds the document details and content See Document Object
ActionRequired	Boolean	No	Flag which denotes if the sender deems an action is required or not Value: True/False
MedicationChanged	Boolean	No	Flag which denotes if the medication has changed or not Value: True/False
Urgent	Boolean	No	Flag which denotes if the document is urgent or not Value: True/False
ClinicalCodes	List – ClinicalCode Object	No	List of ClinicalCode objects which are to be sent into the clinical system See Clinical Code Object
Notes	String	No	Notes from Sender Max Length: 255
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 Check Value: True/False

Document Object

Field	Type	Mandatory	Description
Description	String	Yes	Document Description Max length: 255
EventDate	Date/Time	Yes	Date and Time of the related event. Date must NOT be in the future Format: DateTime ISO 8601 UTC Example: 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 Max length: 50
FilingSectionFolder	String	No	Filing folder description which will be mapped to DM10 filing folder Id using a case insensitive lookup if a mapping exists Max length: 50
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. Max length: 10 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 bytes Max length: 40 Optional and will be allocated if omitted
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 Formats: NHS or CHI Number Validation: MOD11 Max length: 10
FamilyName	String	Yes	Surname of patient – used as part of patient lookup Max length: 255
GivenNames	String	Yes	Patient’s forenames – used as part of patient lookup  Max length: 255
Gender	Enum – ePatientGender	Yes	Patient’s gender– used as part of patient lookup Validation: Against the range of enum values if supplied – defaults to unknown Valid Values: 0 – Unspecified 10 – Male 20 – Female
BirthDate	Date	Yes	DOB of the patient – used as part of patient lookup Validation: No future dates Format: DateTime ISO 8601 UTC Example: 2017-11-16T08:53:41.8653032+00:00

Sender Object

Field	Type	Mandatory	Description
OdsCode	String	Yes	ODS code of sending organisation  Max length: 10
Organisation	String	Yes	Description of Organisation Max length: 255
Department	String	Yes	Sending department name Max length: 255
Person	String	Yes	Person clinically responsible for the document Max 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 Snomed Validated against the range of enum values Accepted Values: Read = 0 Snomed = 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