HD4DP v2 S2S API

Introduction

The HD4DP v2 S2S API is a unified Application Programming Interface (API) that will allow participating Healthcare Organizations (HCO) to submit DCDs data to HD4DP2.0 fully automated.

In the manual of the application HD4DP v2 we provide detailed information about the S2S API. Please read this documentation before its project specific use.

Important note:

For code fields (fieldType = 'CODE') the id of the codeListValue item must be sent, not the code value or the label. In future releases it will be made possible to also send the code value.

Training

Below you can review the S2S API training organized by healthdata.be:

HD4DP2_S2S_API_Training_recording_PART01 Download

HD4DP2_S2S_API_Training_recording_PART02 Download

HD4DP2_S2S_API_Training_recording_PART03 Download

pedro.fernandez Fri, 04/12/2024 - 11:07

1. End-to-End process to submit DCD registrations

API description
Get organizations
Get the DCD menu structure
Get DCD field definitions
Get DCD payload example
Submit DCD registrations
User password
Submission of drafts
Adding separators to a NISS number

API description

The baseURL to be used has to following built: https://<hd4dp_url>/proxy

API end-point	Response	Authentication	Notes
{{baseURL}}/api/organizations	List of organizations. Client must select the right *organizationId*	No	Current existing end-point is: /api/installation/organizations We’ll create this new end-point with a different signature re-routing the call to this existing one or we will refactor the existing one to this new signature.
{{baseURL}}/api/dcd/menu/structure? organization-id={organizationId}	List of projects of the given organization, dcds of each project, dcdVersions of each dcd in a JSON format Client can get *dcdId* and *dcdVersionId* (optional) which are needed on following API calls.	No	https://github.com/Sciensano-Healthdata/hd4-formio/blob/develop/dev/mock_menu_structure/menu-structure.json
{{baseURL}}/api/dcd/payload/definition? dcd-id={dcdId}; <optional>version={version}; <optional>language-id={languageId}	List of all the fields of the form as well as their corresponding data-types that are allowed in the json data structure for the *Payload*	Yes	This field names values are the key properties in the formIO json config form. When we implement this new api end-point, we need to parse the json content in order to get the key properties. Given these field keys, we’ll get each field definition from new API end-points helpers: /api/dcd/field?field-id={fieldId} /api/dcd/codelist?codelist-id={codelistId} These ones are described in the next table. <optional parameter> version={version} : If this parameter is not provided, latest one is assumed <optional parameter> language-id = {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: en: English nl: Dutch fr: French Client must build this json object as the payload data to be sent based on this list of fields, on the last api call
{{baseURL}}/api/dcd/payload/example?dcd-id={dcdId}; <optional>version={version}	Example of payload in JSON format	Yes	Providing this API end-point in order to help the Client on the Payload build with an example <optional parameter> version={version} : If this parameter is not provided, latest one is assumed
{{baseURL}}/api/dcd/payload/submit? organization-id={*organizationId}; dcd-id={**dcdId}; <optional>version={**version}; <optional>data-src-type={**dataSrcType}; POST Payload*	Results info if succeed Error info if failed	Yes	Some implementation tasks is needed in here in order to return the result info (either succeed or failed). Similar like the one in *HDConnectProxyRestTemplate.postCsv* method, and the *CsvExecutionResult* object build. <optional parameter> version={version} : If this parameter is not provided, latest one is assumed. <optional parameter> data-src-type={dataSrcType} : permitted values: API CSV If this parameter is not provided, default values is <HD4DP>.
{{baseURL}}/api/dcd/payload/submit?organization-id={organizationtId};dcd-id={dcd-id};<optional>dcd-version-id={dcdVersionId};<optional>incl-submit-data={inclSubmitData}; <optional>incl-submit-results={inclSubmitResults}; *GET method*	List of submitted dcds data and/or their corresponding business keys or validation errors.	Yes	<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, lastest one is assumed <optional parameter> incl-submit-data={inclSubmitData} : If this parameter is not provided, default values is <false> <optional parameter> incl-submit-results={inclSubmitResults} : If this parameter is not provided, default values is <true>

Get organizations

Request example

GET {{baseURL}}/api/organizations

Request response

[

{

"organizationId": 1,

"organizationCode":"12345",

"name":"First Organization Name",

"loginMethods":[

"USERNAME_PASSWORD",

"EID"

]

},

{

"organizationId": 2,

"organizationCode":"32154",

"name":"Second Organization Name",

"loginMethods":[

"EID"

]

}

]

Request example

GET {{baseURL}}/api/dcd/menu/structure?organization-id={organizationId}

Request parameters

{organizationtId}: Id of the organization for which we want to list the menu structure
{{baseURL}}: the value for this field is https://<hd4dp_url>/proxy

Request response

All the menu structure for that organization, including projects, dcds of each project and dcd versions of each dcd, in a JSON format.

[

{

"id": 4,

"key": "zephyr_pneumo_program",

"projects": [

{

"id": 4,

"key": "zephyr_pneumo_project",

"dcds": [{

"id": 9,

"key": "zephyr_pneumo_t1_dcd",

"dcdVersions": [{

"id": 9,

"version": 1,

"supportsEN": false,

"supportsFR": true,

"supportsNL": true

}]

{

"id": 10,

"key": "zephyr_pneumo_tr_dcd",

"dcdVersions": [{

"id": 10,

"version": 1,

"supportsEN": false,

"supportsFR": true,

"supportsNL": true

}]

. . .

]

Get DCD field definitions

Request example

GET {{baseURL}}/api/dcd/payload/definition?dcd-id={dcdId};version={version};language-id={languagerId}

Request parameters

{dcdId}: Id of the dcd
<optional parameter> {version}: If this parameter is not provided, latest one is assumed
<optional parameter> {languageId}: language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values:
- en: English
- nl: Dutch
- fr: French

Request response

{

"CD_SURGL_APPR_FEMO": {

"field_type": "CODE",

"data_type": "number",

"code_list": [

{

"ID": 68224,

"CODE_VALUE": "870646003",

"LABEL_EN": "Femoral (Hemi)"

{

"ID": 68225,

"CODE_VALUE": "465954006",

"LABEL_EN": "Femoral + Cup"

}

]

"D_IMPLANT": {

"field_type": "DATE",

"data_type": "timestamp",

"code_list": null

"TX_TPE_INSTRU": {

"field_type": "FREE TEXT",

"data_type": "string",

"code_list": null

"MS_PAT_HGHT": {

"field_type": "FREE TEXT",

"data_type": "number",

"code_list": null

}

Get DCD payload example

Request example

GET {{baseURL}}/api/dcd/payload/example?dcd-id={dcdId};version={version}

Request parameters

{dcdId}: Id of the dcd
<optional parameter> {version}: If this parameter is not provided, latest one is assumed

Request response

Given the previous Payload field definition example on previous chapter, we build a payload content example accordingly.

{

"CD_SURGL_APPR_FEMO": 68224,

"D_IMPLANT": "2021-04-30T22:00:00",

"TX_TPE_INSTRU": "P-432",

"MS_PAT_HGHT": 180

}

Submit DCD registrations

Request example

POST {{baseURL}}/api/dcd/payload/submit?organization-id={organizationId};dcd-id={dcdId};version={version};data-src-type={dataSrcType}

Header:

MediaType.APPLICATION_JSON

Body:

{

"CD_SURGL_APPR_FEMO": 68224,

"D_IMPLANT": "2021-04-30T22:00:00",

"TX_TPE_INSTRU": "P-432",

"MS_PAT_HGHT": 180

{

"CD_SURGL_APPR_FEMO": 68225,

"D_IMPLANT": "2021-04-14T22:00:00",

"TX_TPE_INSTRU": "P-545",

"MS_PAT_HGHT": 1209

{

"CD_SURGL_APPR_FEMO": 68224,

"D_IMPLANT": "2021-05-01T22:00:00",

"TX_TPE_INSTRU": "T-678",

"MS_PAT_HGHT": 210

}

Request parameters

{organizationtId}: Id of the organization for which we want to submit the DCD registration.

{dcdId}: Id of the DCD we want to submit.
<optional parameter> {version}: Id of the DCD Version we want to submit. If this parameter is not provided, latest one is assumed.
<optional parameter> {dataSrcType}: The data source type e.g: API or CSV.

Request payload

{Header}: MediaType.APPLICATION_JSON
{Body}: JSON object with an array of DCDs data to be submitted, following the specifications and examples provided by the described api end-points:

GET /api/dcd/payload/definition
GET /api/dcd/payload/example

Request response

Client get a response per each DCD line. If the DCD submission was successful, Client will get a TXT_BUSINESS_KEY value. If it was failed, Client will get an error detailed info: Http Status Code, Name and Exception details:

{

"TX_BUSINESS_KEY": "NISS 12.06.01-052.46 30/04/2021 67864",

{

"HTTP_STATUS_CODE": 405,

"HTTP_STATUS_NAME": "Method Not Allowed",

"HTTP_STATUS_EXCEPTION_DETAILS": "Exception details for Method Not Allowed example",

"TX_BUSINESS_KEY": "NISS 12.06.01-071.48 01/05/2021 67864",

}

User / password

The username and password can be requested at our Servicedesk.

Submission of drafts

To submit a draft, the only thing to add is the key STATUS (all upper case) with the value "draft" to the request, like this:

"STATUS": "draft",

If the status is sent as "draft", a draft registration is created. In case of a successful submission the user receives a HTTP 202 (Accepted) notification with an empty business key, like this:

If the status key is not sent, the default value "submit" is used. The user performs a complete submission, and in case of a successful submission the user receives a HTTP 202 (Accepted) notification with a business key, like this:

Note that only "draft" status needs to be sent when sending a draft. The status "submit" is not necessary when performing a complete submission.

In the GUI, the difference is that the draft submission has the status open while the complete submission has the status submitted:

Once the draft is submitted in the GUI, the business key is generated and the process completed.

Adding separators to a NISS number

It is not necessary to add separators in a NISS number when uploading a file using S2S API. You can fill the NISS number out both with or without seperators. E.g.: 85.04.02-169.32 or 85040216932.

pedro.fernandez Wed, 04/10/2024 - 12:04

2. API Endpoint for supporting the DCD submit process

API description
Get DCD field definition list
Get DCD code list values
Get DCD menu translations
Get DCD field definition translations
Search for SADMI medical devices
Adding repeatable blocks to payload

API description

The baseURL to be used has to following built: https://<hd4dp_url>/proxy

API end-point	Response	Notes
{{baseURL}}api/dcd/field? dcd-id={dcdId}; <optional>dcd-version-id={dcdVersionId}; <optional>included-codelist-values={inclCodelistValues}; <optional>field-name={fieldname}; <optional>language-id={languageId}	List of DCD fields definition, even with codelist values if the field is CODE field type.	<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, latest one is assumed <optional parameter> included-codelist-values={inclCodelistValues}: permitted values: true False If this parameter is not provided, default value is <true>. <optional parameter> field-name={fieldname}: A field name e.g: TX_AUTHOR_GR <optional parameter> {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: en: English nl: Dutch fr: French
{{baseURL}}/api/dcd/codelist? code-list-id={codelistId}; <optional>language={language}	List of values for the codelist of the given codelistId.(List<CodeListItem>)	Checking and getting this info based on MDM -> CODE_LIST table and the relationed tables (CODE, CODE_CONTENT, etc.) See *MDM – Field description – DB model* diagram at the Attachment chapter for more details. <optional parameter> {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: en: English nl: Dutch fr: French
{{baseURL}}/api/dcd/menu-translations? dcd-id={dcdId}; <optional>dcd-version-id={dcdVersionId}; <optional>language-id={languageId}		<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, lastest one is assumed <optional parameter> {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: en: English nl: Dutch fr: French
{{baseURL}}/api/dcd/field/translation? dcd-id={dcdId}; <optional>dcd-version-id={dcdVersionId}; <optional>language-id={languageId}; <optional>field-name={fieldName}	List of fields translations for a given dcdId in the specified languageId (English if it is not provided) in a JSON format. Optional fieldId parameter can provided just for getting this info but only for this fieldId.	<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, lastest one is assumed <optional parameter> {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: en: English nl: Dutch fr: French <optional parameter> field-name={fieldName}: A field name e.g: TX_AUTHOR_GR
{{baseURL}}/api/externalreference/sadmi? notificationCode={notificationCode}; name={name}; reference={reference}; distributorName={distributorName}; manufacturerName={manufacturerName}; classificationCode={classificationCode}	List of Medical Device Types: NotificationCode Name Reference URL Distributor Manufacturer Classification State Client must select the right info needed.

Get DCD field definition list

Request example

GET {{baseURL}}/api/dcd/field?dcd-id={dcdId};dcd-version-id={dcdVersionId};included-codelist-values={inclCodelistValues};field-name={fieldName};language-id={languageId};

Request parameters

{dcdId} : Id of the menu dcd which we want to get all the translations.
<optional parameter> {dcdVersionId} : If this parameter is not provided, latest one is assumed.
<optional parameter> {includedCodelistValues}: boolean value (true or false). If this parameter is not provided, default value will be true. If true and for those fields with type equal to CODE, codelist values will be provided in the result.

<optional parameter> {fieldName}: A field name e.g: TX_AUTHOR_GR
<optional parameter> {languageId} : language id for the menu options example results. If this parameter is not provided, default language will be English. Current permitted values:
- en: English
- nl: Dutch
- fr: French

Request response

with parameter includeCodelistValues equal to true (default value)

{

"TX_TPE_INSTRU": {

"field_type": "FREE TEXT",

"code_list": null

"D_IMPLANT": {

"field_type": "DATE",

"code_list": null

"MS_PAT_XXXX": {

"field_type": "UNKNOWN",

"code_list": null

"MS_PAT_HGHT": {

"field_type": "CODE",

"code_list": [

{

"ID": 68224,

"CODE_VALUE": "870646003",

"LABEL_EN": "Femoral (Hemi)"

{

"ID": 68225,

"CODE_VALUE": "465954006",

"LABEL_EN": "Femoral + Cup"

}

]

}

with parameter includeCodelistValues equal to false

{

"TX_TPE_INSTRU": {

"field_type": "FREE TEXT",

"code_list": null

"D_IMPLANT": {

"field_type": "DATE",

"code_list": null

"MS_PAT_XXXX": {

"field_type": "UNKNOWN",

"code_list": null

"MS_PAT_HGHT": {

"field_type": "CODE",

"code_list": 23

}

Get DCD code list values

Request example

GET {{baseURL}}/api/dcd/codelist?codelist-id={codelistId};language-id={languageId}

Request parameters

{codelistId} : Id of codelist which we want to get the permitted values
<optional parameter> {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values:
- en: English
- nl: Dutch
- fr: French

Request response

{

"ID": 68224,

"CODE_VALUE": "870646003",

"LABEL_EN": "Femoral (Hemi)"

{

"ID": 68225,

"CODE_VALUE": "465954006",

"LABEL_EN": "Femoral + Cup"

}

Request example

GET {{baseURL}}/api/dcd/menu-translations?dcd-id={dcdId};dcd-version-id={dcdVersionId};language-id={languageId}

Request parameters

{dcdId} : Id of the menu dcd which we want to get all the translations.
<optional parameter> {dcdVersionId} : If this parameter is not provided, lastest one is assumed.
<optional parameter> {languageId} : language id for the menu options example results. If this parameter is not provided, default language will be English. Current permitted values:
- en: English
- nl: Dutch
- fr: French

Request response

Example 1: languageId = “en” - English language menu translations

{

"zephyr_ortho_program": "QERMID - Orthopedics",

"zephyr_ortho_knee_project": "Orthopride knee",

"zephyr_ortho_knee_t1_dcd": "Primo-implantation"

{

"zephyr_ortho_program": "QERMID - Orthopedics",

"zephyr_ortho_knee_project": "Orthopride knee",

"zephyr_ortho_knee_t2_dcd": "Revision"

}

. . . . .

}

Example 2: languageId = “nl” - Dutch language menu translations

{

"zephyr_ortho_program": "QERMID - Orthopedie",

"zephyr_ortho_knee_project": "Orthopride knie",

"zephyr_ortho_knee_t1_dcd": "Primo-implantatie"

{

"zephyr_ortho_program": "QERMID - Orthopedie",

"zephyr_ortho_knee_project": "Orthopride knie",

"zephyr_ortho_knee_t2_dcd": "Revisie"

. . . . .

}

Example 3: languageId = “fr” French language menu translations

{

"zephyr_ortho_program": "QERMID - Orthopédie",

"zephyr_ortho_knee_project": "Orthopride genou",

"zephyr_ortho_knee_t1_dcd": "Primo-implantation"

{

"zephyr_ortho_program": "QERMID - Orthopédie",

"zephyr_ortho_knee_project": "Orthopride genou",

"zephyr_ortho_knee_t2_dcd": "Revision"

}

Get DCD field definition translations

Request example

GET {{baseURL}}/api/dcd/fields/translation?dcd-id={dcdId};dcd-version-id={dcdVersionId};language-id={languageId};field-id={fieldId}

Request parameters

{dcdId} : Id of the menu dcd which we want to get all the translations.
<optional parameter> {dcdVersionId} : If this parameter is not provided, lastest one is assumed.
<optional parameter> {languageId} : language id for the menu options example results. If this parameter is not provided, default language will be English. Current permitted values:
- en: English
- nl: Dutch
- fr: French

<optional parameter> {fieldName} : Id of field which we want to get the translation from

Request response

Example 1: languageId = "en" - English language fields translations

{

"author_group": "Authors group",

"CD_SLEEVE_LON": "Long sleeves",

"TX_TTL_UNT": "Unit",

"TX_CTNT_BEF_CONT_VEN_ARTER": "Before venous/arterial contact",

"CD_NAIL_DIRT": "Dirty nails",

"CD_PLSH": "Nail polish",

"TX_NHH": "No hand hygiene",

"CD_SITE": "Site number",

"CD_NAIL_EXT": "Nail extensions",

"TX_TTL_STDY": "Study design",

"CD_WATCH": "Wearing a watch",

"D_OBS": "Observation date",

"T_STP_OBS": "Time end observation period",

"CD_OPT_MDL": "Participation module optional",

"CD_SPLTY": "Specialty of the ward",

"CD_PROF": "Profession",

"TX_TTL_OBS": "Observations",

"CD_NAIL_LON": "Long nails",

"CD_RING": "Wearing a ring"

}

Example 2: languageId = "nl" - Dutch language fields translations

{

"author_group": "Auteursgroep",

"CD_SLEEVE_LON": "Lange mouwen",

"TX_TTL_UNT": "Eenheid",

"TX_CTNT_BEF_CONT_VEN_ARTER": "Voor contact met intravasculair stelsel",

"CD_NAIL_DIRT": "Vuile nagels",

"CD_PLSH": "Nagellak",

"TX_NHH": "Geen handhygiëne",

"CD_SITE": "Campus nummer",

"CD_NAIL_EXT": "Kunst-nagels",

"TX_TTL_STDY": "Study design",

"CD_WATCH": "Het dragen van polshorloge",

"D_OBS": "Observatiedatum",

"T_STP_OBS": "Tijdstip einde observatieperiode",

"CD_OPT_MDL": "Deelname optioneel module",

"CD_SPLTY": "Specialiteit van de dienst",

"CD_PROF": "Beroepsgroep",

"TX_TTL_OBS": "Observaties",

"CD_NAIL_LON": "Lange nagels",

"CD_RING": "Het dragen van ring"

}

Example 3: languageId = "fr" - French language fields translations

{

"author_group": "Groupe d’auteurs",

"CD_SLEEVE_LON": "Longues manches",

"TX_TTL_UNT": "Unité",

"TX_CTNT_BEF_CONT_VEN_ARTER": "Avant contact veineux/artériel",

"CD_NAIL_DIRT": "Ongles sales",

"CD_PLSH": "Ongles vernis",

"TX_NHH": "Pas d’hygiène des mains",

"CD_SITE": "Numéro du site",

"CD_NAIL_EXT": "Ongles artificiels",

"TX_TTL_STDY": "Study design",

"CD_WATCH": "Le port d’une montre",

"D_OBS": "Date de l’observation",

"T_STP_OBS": "Heure fin de la période d’observation",

"CD_OPT_MDL": "Participation module optionel",

"CD_SPLTY": "Spécialité du service",

"CD_PROF": "Profession",

"TX_TTL_OBS": "Observations",

"CD_NAIL_LON": "Ongles longs",

"CD_RING": "Le port d’une bague"

}

Search for SADMI medical devices

Request example

GET {{baseURL}}/api/externalreference/sadmi?

notificationCode={notificationCode};

name={name};

reference={reference};

distributorName={distributorName};

manufacturerName={manufacturerName};

classificationCode={classificationCode}

Request parameters

<optional parameter> {notificationCode}
<optional parameter> {name}
<optional parameter> {reference}
<optional parameter> {distributorName}

<optional parameter> {manufacturerName}
<optional parameter> {classificationCode}

Request response

{

"NotificationCode": "First Notification Code Example",

"Name": "First Name Example",

"Reference": "First Reference Example",

"URL": "http://first.url.example",

"Distributor": {

"NotificationNumber": "First Notification Number Example",

"Name": "First Distribuitor Name Example"

"Manufacturer": {

"Name": "First Manufacturer Name Example",

"CountryCode": {

"value": "First Country Code Value Example",

"standard": "First Country Code Standard Example"

"CountryName": {

"value": "First Country Name Value Example",

"lang": "First Country Name Lang Example"

}

"Classification": {

"Code": "First Classification Code Example",

"Description": "First Classification Description Example"

"State": {

"Name": "First State Name Example",

"ValidFrom": "First State ValidFrom Example",

"ValidTo": "First State ValidTo Example"

}

{

"NotificationCode": "Second Notification Code Example",

"Name": "Second Name Example",

"Reference": "Second Reference Example",

"URL": http://second.url.example,

. . . . .

}

Adding repeatable blocks to payload

Example

    "TX_TTL_IMPLANT_DATA": [
        {
            "CD_IMPLANT": "127909",
            "CD_PAC_SADMI_NOTIFIC": "000017811475",
            "CD_IMPLANT_CAT": "",
            "CD_IMPLANT_PRD_NM": "",
            "TX_IMPLANT_PRODUC": "",
            "TX_IMPLANT_DSTRBTR": "",
            "TX_IMPLANT_DESC": ""
        },
        {
            "CD_IMPLANT": "127910",
            "CD_PAC_SADMI_NOTIFIC": "",
            "CD_IMPLANT_CAT": "127906",
            "CD_IMPLANT_PRD_NM": "productnaam",
            "TX_IMPLANT_PRODUC": "fabrikant",
            "TX_IMPLANT_DSTRBTR": "verdeler",
            "TX_IMPLANT_DESC": "opmerking product"
        }
    ],

pedro.fernandez Wed, 04/10/2024 - 11:51

3. MDM Field description - DB Model

pedro.fernandez Thu, 10/05/2023 - 15:13

4. Swagger API

The Swagger API is available on the local installation of HD4DP2.0. Go to https://<hd4dp2_url>/proxy/api-docs.html.

Some API calls are password protected (S2S api). If you want access to this API, you can request the user/password by creating a ticket in our servicedesk.

Attention: The baseURL to be used has to following built: https://<hd4dp_url>/proxy

jeroen.maelbrancke Wed, 04/10/2024 - 11:58

5. Postman collection

Postman collection HD4DP2.0 can be downloaded here.

HD4DP2.0 collection Download

Attention: The baseURL to be used has to following built: https://<hd4dp_url>/proxy

jeroen.maelbrancke Wed, 04/10/2024 - 11:58

HD4DP v2 S2S API

Introduction

Training

1. End-to-End process to submit DCD registrations

Table of contents

API description

Get organizations

Request example

Request response

},

Get the DCD menu structure

Request example

Request parameters

Request response

Get DCD field definitions

Request example

Request parameters

Request response

Get DCD payload example

Request example

Request parameters

Request response

Submit DCD registrations

Request example

Request parameters

Request payload

Request response

User / password

Submission of drafts

Adding separators to a NISS number

2. API Endpoint for supporting the DCD submit process

Table of contents

API description

Get DCD field definition list

Request example

Request parameters

Request response

Get DCD code list values

Request example

Request parameters

Request response

Get DCD menu translations

Request example

Request parameters

Request response

Get DCD field definition translations

Request example

Request parameters

Request response

Search for SADMI medical devices

Request example

Request parameters

Request response

Adding repeatable blocks to payload

Example

3. MDM Field description - DB Model

4. Swagger API

5. Postman collection