Figure 1: Use case diagram for remote patient monitoring
| What is TuumIO Protocol? | Get an overview of the core components of the protocol. | /pages/X9wjUQOTNolESGmoDwuM#what-is-care.platform | ||
| Protocol Guide | Learn how to build and author decentralized applications (dApps). | /pages/Agsdt6kNZGVNAaPtmFoP | ||
| Tutorials | Create an Event Booker Create a Library Explorer | /pages/3F07dNYh3e7IjfLOYXYR |
Figure 1: Use case diagram for remote patient monitoring
Figure 2: Use case diagram for insurance claims processing
Figure 3: Use case diagram for an employee rewards system
Figure 4: High-level Platform Architecture
├── sample-network/
├── definitions/
│ ├── card/
│ ├── ddf/
│ ├── event/
│ ├── event-handler/
│ ├── python-event-handler/
│ ├── resources/
│ └── td/
└── input.json
| Term | Definition |
|---|---|
| TuumIO Card (Card) | An interactive module encapsulating multiple data types, user interface elements, and interoperable functions. "TuumIO Card" and "Card" are used interchangeably in this document. |
| TuumIO Data Node (TDN) | A specialized node that acts as a database, facilitating secure data storage, retrieval, and exchange with external systems. |
| TuumIO Ledger | A decentralized record of events or transactions within a network, as defined by the protocol. |
| TuumIO Network (Network) | A digital network of various healthcare roles, operating based on rules defined in a TuumIO Protocol. "TuumIO Network" and "Network" are used interchangeably in this document. |
| TuumIO Node (Node) | A secure digital entity that enables secure data exchange and event handling. "TuumIO Node" and "Node" are used interchangeably in this document. |
| TuumIO Protocol (Protocol) | A governance framework that defines the rules for data exchange and communication in networks. "TuumIO Protocol" and "Protocol" are used interchangeably in this document. |
| TuumIO Wallet (Wallet) | A mobile app that serves as a gateway to various industry services and dApps. It provides a secure way to store and manage digital assets and records. "TuumIO Wallet" and "Wallet" are used interchangeably in this document. |
| TuumIO Vault (Vault) | A decentralized storage, facilitating secure data management and storage. |
| Chain | An enterprise-level solution that offers various industry services. |
| dApps | A decentralized application in Web3 that offers various functionalities, including interactions, data exchanges, and workflows for specific user roles. |
| Data definition file (DDF) | A JSON file specifying the structure of data stored within the TuumIO Data Node, defining data elements, data types, and validation rules. |
| Event | A message or record signifying an occurrence within a network or journey. Events define interactions and communications between roles and nodes. |
| Event Handler | A set of instructions that execute tasks based on specific events. These tasks include updating records, transforming data, and identifying recipients for the next event. |
| Journeys | A sequence of interconnected TuumIO Cards, defining functionalities, including interactions, data exchanges, and workflows for specific user roles. |
| Role | A fundamental element in the protocol that defines a specific participant type, such as patient, physician, admins, etc. Each role is associated with corresponding consents and cards within the protocol. |
| SOLVE | A cryptocurrency utility token used throughout the platform to facilitate payments and transactions. |
| Tile | A modular component in a card user interface that displays data or provides functionality. |
| Field Name | Value Type | Description |
|---|---|---|
| network_id | string | The unique ID associated with the network. |
| node_url | string | The URL of the network node where it is deployed. |
| name | string | The unique name of the network. |
| version | number | The version number of the network protocol. |
| description | string | The short description of the network. |
| publish_date | string | The date when the network protocol is published. |
| effective_date | string | The date when the protocol is effective or operational within the network. |
| Field Name | Value Type | Description |
|---|---|---|
| author_name | string | The name of the network protocol's author (entity or person). |
| author_website | string | The website URL of the author. |
| author_address1 | string | The address of the author (line1). |
| author_address2 | string | The address of the author (line2). |
| geo_fence_countries | string | The list of countries that can join the network. |
| Field Name | Value Type | Description |
|---|---|---|
| role | string | The ID of the role joining the network. |
| join_method | string | The method of joining the network. |
| required_consents | array | The cards which you allow other users in the network to access. |
| terms_and_conditions_checksum | string | The terms and conditions for joining the network. |
| Field Name | Value Type | Description |
|---|---|---|
| deposit_value | string | The deposit value of SOLVE tokens. |
| redemption_value | string | The redemption value of SOLVE tokens. |
| solve_gas_setting | JSON | The SOLVE gas usage setting. |
| event_wise_cost | array | The event and the cost in SOLVE token. |
| event | string | The event used for transactions in the network. |
| cost | integer | The cost in SOLVE gas for each event transaction. |
| Field Name | Value Type | Description |
|---|---|---|
| id | string | The unique ID of the role. |
| name | string | The name of the role. |
| description | string | The description of the role. |
| type | string | The role type is defined in the platform. |
| status | string | The status of the role is set to Active. |
| version | number | The role's version number is updated when the role metadata value changes. |
| td_collections | array | The transactional data records are linked to the role. |
| allow_events_with_role | array | The events allowed for the role. |
| home_card_ref_id | string | The reference ID to the home card for the role. |
| Field Name | Value Type | Description |
|---|---|---|
| id | string | The unique ID of the journey. |
| icon | string | The path to the icon image file. |
| name | string | The name of the journey. |
| description | string | The description of the journey. |
| status | string | The status of the journey is set to Active. |
| start_card_ref_id | string | The reference ID of the journey starting card. |
| roles | string | The roles involved in the journey. |
| journey_data | array | The data model for synchronizing across multiple roles or nodes, triggered by events. See Journey data model. |
| journey_type | string | The journey type is defined in the platform. |
| Field Name | Value Type | Description |
|---|---|---|
| name | string | The unique name of the journey data model. |
| start_event_ids | array | The IDs of start events that trigger data sharing and synchronization. Note: Only the user role with OWNER access can submit the start (init) event. |
| stop_event_ids | array | The IDs of stop events with shared data in the payload, completing the synchronization to all nodes. |
| affected_collections | array | The data collections where payload data is saved. |
| expire_in | string | The number of days (d), weeks (w), or years (y) from initialization until synchronization is stopped. |
| permissions | array | The list of roles and corresponding access permissions. |
| role | string | The reference ID of each role defined in the journey. |
| access | string | The access level permission set for each role. |
| Field Name | Value Type | Description |
|---|---|---|
| id | string | The unique ID of the card. |
| name | string | The name of the card. |
| description | string | The description of the card. |
| status | string | The status of the card is set to Active. |
| card_definition_ref | string | The reference to the UI component of the card. |
| side | string | The side on which data is presented. |
| role | string | The role ID is referenced in the card. |
| transaction_data_ref | string | The reference to the transaction data used upon initialization. |
| journey | string | The journey to which the card belongs. |
| outgoing_events | array | The events or actions triggered by the card. |
| pre_rendering_events | array | The events or actions used to initialize the card. |
| Configurations | Preview |
|---|---|
|
| Configurations | Preview |
|---|---|
|
{\*age} - The text input is set to age that will be used and sent through an event.{\*dateSelected} - The date input is set to key dateSelectedthat will be used and sent through an event.{status} - The selected value is set to key statusthat will be used and sent through an event.{answer} - The selected option is set to key answer that will be used and sent through an event.{answer} - The selected option is set to key answer that will be used and sent through an event.{answer} - The selected option is set to key answer that will be used and sent through an event.{answer} - The selected option is set to key answer that will be used and sent through an event.For subtitle color handling:
In the example, the subtitle is shown as a number next to the title label.
|  | {% code title="Example:" %} ```json { "id": "Tile7b", "subView": [ { "title": { "text": "00t1v5" }, "options": { "key":{ "name":"{answer}" }, "list":[ { "label": "00t1v11", "subTitle":{ "text": "{00t1v11}", "colorCode": "00FF00" }, { "label": "00t1v12" "subTitle":{ "text": "{00t1v12}", "colorCode": "00FF00" }, { "label": "00t1v13" "subTitle":{ "text": "{00t1v13}", "colorCode": "00FF00" } ] } } ], "align":"START", "type": "CONTAINER", "uiAction": "", "order": 1 } ``` {% endcode %} ### Tile8: Scrollable Table This tile represents a scrollable table grid. | Configurations | Preview | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | |{answer} - The selected option is set to key answer that will be used and sent through an event.{answer} - The selected option is set to key answer that will be used and sent through an event.{answer} - The selected option is set to key answer that will be used and sent through an event.For subtitle view:
{answer5} - The selected option from the list is set to key answer5 that will be used and sent through an event.The name of the function: Function.Profile.key
The following keys can be used as input:
| Field | Value | Description |
|---|---|---|
| text | string | The name of the function: Function.Preference.languageThis function is used only inside Tiles. |
The name of the field value to be validated. The supported fieldFormat values are:
| Field Name | Value Type | Description |
|---|---|---|
| id | string | The unique ID of the event. |
| name | string | The name of the event. |
| description | string | The description of the event. |
| code | string | The same as the event name. |
| status | string | The status of the event is set to Active. |
| type | string | The type of event. The possible values are WALLET_LOCAL, WALLET_FROM_NODE, WALLET_TO_NODE, NODE_TO_NODE and NODE_TO_ROLE. |
| event_definition_ref | string | The reference path and ID of the event definition. |
| submit_event_handler | string | The ID of the event handler used for submitting the event. |
| node_event_handlers | array | The list of outgoing event handlers for node events. |
| card | string | The reference ID of the card associated to the event. |
Map of DynamicHandlerValue
(see Dynamic handler value)
| A map of attributes with dynamic values calculated at runtime. | {% code title="Example:" %} ```json { "type": "MAPPER", "name": "Append SAMPLE payload", "order": 1, "dataSource": "EVENT_PAYLOAD", "additionalAttributes": { "createdAt": { "source": "GENERATED", "value": "CURRENT_TIMESTAMP" }, "transactionalGuid": { "source": "GENERATED", "value": "UUID" }, "doctorNodeAddress": { "source": "EVENT", "value": "SENDER" } }, "excludedAttributes": [ "correlationId" ] } ``` {% endcode %} ### Next Event Recipient handler | Parameters | Data type / Values | Description | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | type | `NEXT_EVENT_RECIPIENT` | The handler type. | | order | Integer | The order of the handler in the execution chain. | | name | String | The name of the handler which is used for logging. | | handlerOutput | `EMPTY`, `EVENT_PAYLOAD`, `HANDLER_ARGUMENTS` | The handler output that will be passed as an argument to the next handler. | | recipientAddress |DynamicHandlerValue
(see Dynamic handler value)
| The dynamic value represents the recipient of the next event. | {% code title="Example:" %} ```json { "type": "NEXT_EVENT_RECIPIENT", "name": "Fetch SAMPLE target doctor", "order": 2, "recipientAddress": { "source": "HANDLER_ARGUMENTS", "value": "doctorNodeAddress" }, "handlerOutput": "HANDLER_ARGUMENTS" } ``` {% endcode %} ### Expression Language handler The expression language used for this handler type is based on Spring Expression Language (SpEL). For more information, see the documentation for [Spring Expression Language (SpEL)](https://docs.spring.io/spring-framework/docs/3.0.x/reference/expressions.html). Here are the operators supported in the language: | Type | Operators | | ----------- | -------------------------------------------- | | Arithmetic | +, -, \*, /, %, ^, div, mod | | Relational | <, >, ==, !=, <=, >=, lt, gt, eq, ne, le, ge | | Logical | and, or, not, &&, \|\|, ! | | Conditional | ?: | | Regex | matches | Here are the parameters in the event handler definition: | Parameter | Data type / Values | Description | | ------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | type | `EXPRESSION_LANGUAGE` | The handler type. | | order | Integer | The order of the handler in the execution chain. | | name | String | The name of the handler which is used for logging. | | dataSource | `EMPTY`, `EVENT_PAYLOAD`, `HANDLER_ARGUMENTS` | The data source of the record which will be inserted into the collection. | | computedAttributes | Map of expressions, where the key is a variable name, and the value is the expression itself. | The handler executes the expression and puts the value inside the specified variable. | {% code title="Example 1:" %} ```json { "type": "EXPRESSION_LANGUAGE", "name": "Calc", "order": 2, "dataSource": "EMPTY", "computedAttributes": { "c": "arguments['a']+arguments['b']" } } ``` {% endcode %} In Example 1, let's assume that the `HANDLER_ARGUMENTS` has variables `a` and `b`. If the variables represent numeric values, such as `a=1` and `b=2`, then the result will be `1+2=3`. If the variables represent string values, such as `a='1'` and `b='2`', then the result will be `'1'+'2'='12'`. {% code title="Example 2:" %} ```json { "type": "EXPRESSION_LANGUAGE", "name": "Calc", "order": 2, "dataSource": "EMPTY", "computedAttributes": { "res": "arguments[users].?[country=='USA'].size()" } } ``` {% endcode %} In Example 2, let's assume that the `HANDLER_ARGUMENTS` has a variable `user`, which represent a list with the following value: ```json [ { "name": "John", "country": "USA" }, { "name": "Sam", "country": "Canada" }, ] ``` The expression `arguments[users].?[country=='USA'].size()` will filter the items which has the country value set to `"USA"`. Then it calculates the size, which returns the count. In this case, the result will be `1`. {% code title="Example 3:" %} ```json { "type": "EXPRESSION_LANGUAGE", "name": "Calc", "order": 2, "dataSource": "EMPTY", "computedAttributes": { "res": "arguments[users].?[country=='USA'].size() > 0 ? 'USA_PRESENT' : 'USA_NOT_PRESENT'" } } ``` {% endcode %} In Example 3, let's assume that the `HANDLER_ARGUMENTS` has a variable `user`, which represent a list with the following value: ```json [ { "name": "John", "country": "USA" }, { "name": "Sam", "country": "Canada" }, ] ``` The expression `arguments[users].?[country=='USA'].size() > 0 ? 'USA_PRESENT' : 'USA_NOT_PRESENT'` will filter the items which has the country value set to `"USA"`. Then it calculates the size, which returns the count. In this case, the count is `1`. If the count is greater than 0, then the result will be `'USA_PRESENT'`. ### Custom (JAR) handler | Parameter | Data type / Values | Description | | --------- | ------------------ | --------------------------------------------------------------------- | | type | CUSTOM | The handler type. | | order | Integer | The order of the handler in the execution chain. | | jarUrl | String | The URL where the JAR file with the handler implementation is stored. | | className | String | The full Java class name that implements the corresponding interface. | {% code title="Example:" %} ```json { "type": "CUSTOM", "order": 2, "jarUrl": "https://a.solvecare.net/artifactory/libs-snapshot-local/care/solve/generic/node/hello-world-handler/1.0.4-SNAPSHOT/hello-world-handler-1.0.4-20220406.133327-6.jar", "className": "care.solve.node.handler.demo.patient.PatientComputeBmiHandler" } ``` {% endcode %} # Python Event Handlers This section provides examples on how to configure Python event handlers. The Python event handler contains a set of base classes that provide an interface to the platform's core components, such as Vault, Wallet, Node, and TuumIO Data Node (TDN). The following template includes base classes and functions that provide features to retrieve, search, update, and save data. ## Python template {% code title="Example:" fullWidth="false" %} ```python class TDN: def __init__(self, index: str): self.context = context self.index = index def find_all(self, parameters: SearchRequest) -> List: return self.context.getCareDataNodeProvider().findAll(self.index, parameters) def find_first(self, parameters: SearchRequest) -> SearchResponse: return self.context.getCareDataNodeProvider().findFirst(self.index, parameters) def raw_search(self, from_row, num_rows, search_request) -> List: return self.context.getCareDataNodeProvider().rawSearch(self.index, from_row, num_rows, search_request) class Wallet: def __init__(self): self.context = context def get_wallet_profile(self) -> WalletProfile: return self.context.getMainNetNodeProvider().getMainNetProfile(ProfileType.WALLET) def get_phone_profile(self) -> PhoneProfile: return self.context.getMainNetNodeProvider().getMainNetProfile(ProfileType.PHONE) def get_contact_profile(self) -> ContactProfile: return self.context.getMainNetNodeProvider().getMainNetProfile(ProfileType.CONTACT) def update_wallet_profile(self, data: Map, attribute_mapping: Map) -> Map: self.context.getMainNetNodeProvider().updateWalletProfile(data, attribute_mapping) return data def update_phone_profile(self, data: Map, attribute_mapping: Map) -> Map: self.context.getMainNetNodeProvider().updatePhoneProfile(data, attribute_mapping) return data def update_contact_profile(self, data: Map, attribute_mapping: Map) -> Map: self.context.getMainNetNodeProvider().updateContactProfile(data, attribute_mapping) return data class Vault: def __init__(self): self.context = context def save(self, collection: str, data: Map) -> Map: vault = self.context.getVaultStorage(collection) guid = vault.save(data) return vault.getByGuid(guid) def update(self, collection: str, criteria: List, data: Map, insert_if_absent: bool) -> Map: vault = self.context.getVaultStorage(collection) guid = vault.update(criteria, data, insert_if_absent) return vault.getByGuid(guid) def search(self, collection: str, filters: List) -> List: vault = self.context.getVaultStorage(collection) return vault.search(filters) class Node: def __init__(self, context: HandlerExecutionContext): self.context = context def info(self) -> NodeInfo: return self.context.getNodeInfo() def execute(ctx: HandlerExecutionContext) -> Map: result = HashMap(arguments()) # PUT YOUR CODE HERE return result ``` {% endcode %} ## Use case example 1. Define the event in the `input.json` file. {% code title="Example:" %} ```json { "id": "ev-tdn-broadcast", "name": "N.TDN.BROADCAST.MESSAGE", "code": "N.TDN.BROADCAST.MESSAGE", "description": "TDN broadcast message", "status": "Active", "type": "NODE_TO_ROLE", "from_role": "DATA_NODE", "to_role": "PATIENT", "event_definition_ref": "event/ev-cdn-broadcast.json", "node_event_handlers": [ "eh-n-patient-process-py" ] } ``` {% endcode %} 2. Create the event definition: `event/ev-cdn-broadcast.json`*.* {% code title="Example:" %} ```json { "definition": { "description": "Broadcast TDN message", "name": "N_TDN_BROADCAST_MESSAGE", "resource": "N_TDN_BROADCAST_MESSAGE", "type": "EVENT_DATA" }, "structure": { "attributes": [ { "code": "transactionalGuid", "name": "transactionalGuid", "type_definition": { "type": "string" }, "order": 1, "system": false }, { "code": "indexName", "name": "indexName", "type_definition": { "type": "string" }, "order": 2, "system": false }, { "code": "ddfType", "name": "ddfType", "type_definition": { "type": "string" }, "order": 3, "system": false }, { "code": "msgType", "name": "msgType", "type_definition": { "type": "string" }, "order": 4, "system": false }, { "code": "attributes", "name": "attributes", "type_definition": { "type": "collection", "item_type_definition": { "type": "string" } }, "order": 5, "system": false } ] } } ``` {% endcode %} 3. Define the event handler in the `input.json` file. {% code title="Example:" %} ```json { "id": "eh-n-patient-process-py", "name": "N.TDN.BROADCAST.MESSAGE", "description": "N.TDN.BROADCAST.MESSAGE", "status": "Active", "event": "ev-tdn-broadcast", "type": "NODE_EVENT_HANDLER", "python_event_handler_ref": "python-event-handler/eh-n-patient-process.py" } ``` {% endcode %} 4. Create a Python event handler definition that saves the data. {% code title="Example:" %} ```python def execute(ctx: HandlerExecutionContext) -> Map: result = HashMap(arguments()) # PUT YOUR CODE HERE start_row = 0 num_rows = 10 query = { "match_all": {} } page = CDN('DOCTORS').search(start_row, num_rows, query) Vault('MY_DATA').save(page.getContent()) return result ``` {% endcode %} # Transactional Data This section shows the structure and attributes of transactional data. Transactional data contains configurable data that can be referenced from roles, cards, or events within the network. The following example shows the definition of transactional data in `td/td-default.json`. {% code title="Example:" %} ```json { "id": "td-default", "path": "td/td-default.json", "definition": { "collection": "DEFAULT", "description": "DEFAULT", "name": "DEFAULT", "resource": "DEFAULT", "status": "RELEASED", "type": "TRANSACTIONAL_DATA" }, "structure": { "attributes": [ { "code": "transactionalGuid", "name": "transactionalGuid", "type_definition": { "type": "string" }, "order": 1, "required": false, "system": false }, { "code": "createdAt", "name": "createdAt", "type_definition": { "type": "timestamp" }, "order": 2, "required": false, "system": false }, { "code": "answer", "name": "answer", "type_definition": { "type": "string" }, "order": 3, "required": false, "system": false }, { "name": "senderNodeAddress", "code": "senderNodeAddress", "type_definition": { "type": "string" }, "required": false, "system": false, "order": 4 } ] } } ``` {% endcode %} # Test and Publish ### Deployment readiness checklist Before testing and publishing the network, make sure that: * [ ] All files and data are correctly referenced in the `input.json` file. * [ ] There are no logical errors in the referenced data. * [ ] The `/definitions` folder and `input.json` file are packaged into one zip file. * [ ] The DDF and CSV files are ready for upload. * [ ] You have the test environment details where you want to publish the protocol. For more information, see [Publishing the protocol](/protocol-guide/test-and-publish/publishing-the-protocol). # Publishing the protocol {% hint style="info" %} Use Postman to perform the steps for publishing. To get the authorization and environment details, contact [tuumio.support@solve.care](mailto:care.support@solve.care)*.* {% endhint %} ## Fetch MainNet authorization token Initiate a request with the appropriate details for your environment. **POST** {% code overflow="wrap" %} ``` https://{{abc-care-env}}/core-registry-service/oauth/token?grant_type=password&username=%2B{{networkAuthorPhone}}&password={{networkAuthorPassword}}&blockchainAddress={{networkAuthorWalletId}} ``` {% endcode %} Pre-request script: {% code title="Example:" %} ```javascript pm.globals.set("abc-care-env", "dev.env.abc.net"); pm.globals.set("xxx-env", "site000.abc.net/sample-net"); pm.globals.set("networkAuthorPhone", "91888888888"); pm.globals.set("networkAuthorWalletId", "0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"); pm.globals.set("networkAuthorPassword", "999999"); pm.globals.set("networkId", "dev-network-xxx"); ``` {% endcode %} ## Fetch network authorization token **POST** {% code overflow="wrap" %} ``` https://{{eks-env}}/nom/oauth/token?grant_type=exchange_token&exchange_token={{networkAuthorMainNetToken}} ``` {% endcode %} ## Get sponsor address **GET** ```url https://{{eks-env}}/nom/v2/holders/me ``` Post-request script: {% code title="Example:" overflow="wrap" %} ```javascript const jsonData = pm.response.json().nodes; const networkId = pm.globals.get("networkId"); const node = jsonData.filter(r => r.networkId === networkId && r.roleId === 'NETWORK_SPONSOR')[0]; pm.globals.set("sponsorWalletAddress", node.scAddress); ``` {% endcode %} ## Upload the protocol package **POST** {% code overflow="wrap" %} ```url https://{{eks-env}}/generic-protocol-service/v2/packaging/{{networkId}}/restore/zip ``` {% endcode %} ## Publish the protocol package **POST** {% code overflow="wrap" %} ```url https://{{eks-env}}/generic-protocol-service/v2/packaging/{{networkId}}/publish ``` {% endcode %} {% code title="Example:" overflow="wrap" %} ```bash curl --location --globoff 'https://{{eks-env}}/generic-protocol-service/v2/packaging/{{networkId}}/publish' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{networkAuthorCANToken}}' \ --data '{ "certificates":"CERT-12345-2022", "effectiveDate": "20-05-2022", "sponsorWalletAddress": "{{sponsorWalletAddress}}" }' ``` {% endcode %} ## Get publishing state **GET** ``` https://{{eks-env}}/generic-protocol-service/v2/packaging/{{networkId}}/{{networkVersion}} ``` {% code title="Example:" overflow="wrap" %} ```bash curl --location --globoff 'https://{{eks-env}}/generic-protocol-service/v2/packaging/{{networkId}}/{{networkVersion}}' \ --header 'Authorization: Bearer {{networkAuthorCANToken}}' ``` {% endcode %} ## Update TDN Upload the CSV file with the same attributes as the uploaded DDF in the input folder of the Amazon S3 bucket. If necessary, delete existing data. ### Uploading data definition file (DDF) The data definition file contains the model and structure for organizing data in TDN. **POST** {% code overflow="wrap" %} ```url https://{{eks-env}}/{{network-id}}/data-node/v1/ddf ``` {% endcode %} {% code title="Example:" %} ```bash curl --location 'https://data-node/v1/ddf?status=ACTIVE' \ --header 'Authorization: Basic Y2FyZS1iYWNrZW5kOnNlY3JldA==' \ --header 'Content-Type: application/json' \ --data '{ "ddf_type": "us-doctors-sample", "meta_data": { "description": "Sample" }, "messages": [ { "message_category": "CSV", "message_type": "Doctors", "meta_data": { "description": "Sample", "indices": "us-doctors-sample" }, "events": [ { "to_role": "rl-patient", "event": "ev-cdn-broadcast" } ], "attributes": [ { "name": "Provider", "description": "Provider", "required": false, "index_field": true, "type": "integer", "data_location": "Provider" }, { "name": "License", "description": "License", "required": false, "index_field": true, "type": "string", "data_location": "License" }, { "name": "Specialization", "description": "Specialization", "required": false, "index_field": true, "type": "string", "data_location": "Specialization" }, { "name": "Address", "description": "Address", "required": false, "index_field": true, "type": "string", "data_location": "Address" } ] } ] }' ``` {% endcode %} ### Searching data **POST** ``` https://{{eks-env}}/{{network-id}}/elasticsearch/us-doctors-sample/_search ``` {% code title="Example:" %} ```bash curl --location 'https://elasticsearch/us-doctors-sample/_search' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic ZWxhc3RpYzpweFkwMXNQTXMyZTRTdFp3M2U1MjU5N3U=' \ --data '{ "query": { "match_all": {} } }' ``` {% endcode %} ### Deleting existing data from TDN **POST** ``` https://{{eks-env}}/{{network-id}}/elasticsearch/us-doctors-sample/_delete_by_query ``` {% code title="Example:" %} ```bash curl --location 'https://{{eks-env}}/{{network-id}}/elasticsearch/us-doctors-sample/_delete_by_query' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic ZWxhc3RpYzpweFkwMXNQTXMyZTRTdFp3M2U1MjU5N3U=' \ --data '{ "query": { "match_all": {} } }' ``` {% endcode %} ### Checking the count **POST** ``` https://{{eks-env}}/{{network-id}}/elasticsearch/us-doctors-sample/_count ``` {% code title="Example:" %} ```bash curl --location --globoff 'https://{{eks-env}}/{{network-id}}/elasticsearch/us-doctors-sample/_count' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic ZWxhc3RpYzo5UlBJMTMzNFNydHBOMzI1NFNRcjd4clI=' \ --data '{ "query": { "match_all": {} } }' ``` {% endcode %} # Testing the app using BrowserStack 1. Open a web browser, and then go to