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
Docman10_InboundDocumentModel_Example
| Field | Type | Mandatory | Description |
| CaptureSource | Enum | Docman 10: Yes
Docman Connect: Yes | The API capture source for Docman 10 is ‘100’
The API capture source for Docman Connect is ‘2’ |
| Sender | Sender Object | Docman 10: Yes
Docman Connect: Yes | Object which holds details of the Sender |
| RecipientOdsCode | String | Docman 10: Yes
Docman Connect: Yes | ODS Code of the recipient organisation
Max length 10 |
| Patient | Patient Object | Docman 10: No
Docman Connect: Yes | Object which holds details of the patient |
| Document | Document Object | Docman 10: Yes
Docman Connect: Yes | Object which holds the document details and content |
| ActionRequired | Boolean | Docman 10: No
Docman Connect: No | Flag which denotes the Sender deems an action is required |
| MedicationChanged | Boolean | Docman 10: No
Docman Connect: No | Flag which denotes that the sender has changed the patient’s medication |
| Urgent | Boolean | Docman 10: No
Docman Connect: No | Flag which denotes the document is urgent |
| ClinicalCodes | List – ClinicalCode Object | Docman 10: No
Docman Connect: No | List of ClinicalCode objects which are to be sent into the clinical system |
| Notes | String | Docman 10: No
Docman Connect: No | Notes from Sender
Max Length 255 |
| Revision | Boolean | Docman 10: No
Docman Connect: Not used |
Flag to denote the Document is a revision – the Document.Guid property should hold the Document to be revised GUID |
| OverrideSpineCheck | Boolean | Docman 10: No Docman Connect: Yes | Value True overrides the Spine Check. False or excluding the line uses the Spine Check |
Document Object
| Field | Type | Mandatory | Description |
| Guid | Guid | Docman 10: No
Docman Connect: Not Used | Document GUID, leave blank for new documents. For revisions enter GUID of document to be revised and enable Revision property. |
| Description | String |
Docman 10: Yes Docman Connect: Yes | Document Description
Max length 255 |
| EventDate | Date/Time | Docman 10: No
Docman Connect: Yes | Date and Time of the related event.
Date must NOT be in the future |
| Folder | String | Docman 10: No
Docman Connect: 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 | Docman 10: No
Docman Connect: 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 | Docman 10: Yes
Docman Connect: Yes | Physical file content as Bytes |
| FileExtension | String | Docman 10: Yes
Docman Connect: Yes | File extension of the Physical File – the full stop should be omitted but will be removed if present.
Max length 10 |
| FileHash | String | Docman 10: No
Docman Connect: No | SHA1 file has derived from the file content bytes
Max length 40 Optional and will be allocated if omitted |
| LocalHubId | Integer | Docman 10: No
Docman Connect: No | Id from Local Hub Document Table |
| ExternalSystemId | String | Docman 10: No
Docman Connect: No | System ID from sending system |
Patient Object
| Field | Type | Mandatory | Description |
| Identifier | String | Docman 10: No
Docman Connect: No | Patients national identifier – used as part of patient lookup
Either NHS or CHI Number Validated with MOD11 Max length 10 |
| FamilyName | String | Docman 10: No
Docman Connect: Yes | Surname of patient – used as part of patient lookup
Max length 255 |
| GivenNames | String | Docman 10: No
Docman Connect: Yes | Patient’s forenames – used as part of patient lookup
Max length 255 |
| Gender | Enum – ePatientGender | Docman 10: No
Docman Connect: Yes | Patient’s gender– used as part of patient lookup
Validated against the range of enum values if supplied – defaults to unknown Valid Values: 0 – Unspecified 10 – Male 20 – Female |
| BirthDate | Date | Docman 10: No
Docman Connect: Yes | DOB of the patient – used as part of patient lookup
No future dates |
Sender Object
| Field | Type | Mandatory | Description |
| OdsCode | String | Docman 10: Yes
Docman Connect: Yes | ODS code of sending organisation
Max length 10 |
| Organisation | String | Docman 10: No
Docman Connect: Yes | Description of Organisation
Max length 255 |
| Department | String | Docman 10: No
Docman Connect: Yes | Sending department name
Max length 255 |
| Person | String | Docman 10: No
Docman Connect: Yes | Person clinically responsible for the document
Max length 255 |
| Group | String | Docman 10: No
Docman Connect: No | Name of Sender Group to associate the document with in the Connect Console. Group must already exist.
Max length 50 |
Clinical Code Object
| Field | Type | Mandatory | Description |
| Scheme | Enum – eCodeScheme | Docman 10: Yes
Docman Connect: Yes | Type of coding system. Read 2 or Snomed
Validated against the range of enum values |
| Code | String | Docman 10: Yes
Docman Connect: Yes | Clinical code – either Read code or Snomed Concept Id |
| Description | String | Docman 10: Yes
Docman Connect: Yes | Either Read Term or Snomed Description |
| DescriptionId | String | Docman 10: Yes
Docman Connect: Yes | Either Read TermId or Snomed Description Id |
| Value | String | Docman 10: No
Docman Connect: No | Associated clinical value
REQUIRED if ValueUnit set |
| ValueUnit | String | Docman 10: No
Docman Connect: No | Associated clinical value unit of measure
REQUIRED if Value set |