All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.syndesis.connector.fhir.json Maven / Gradle / Ivy

{
  "actions": [
    {
      "actionType": "connector",
      "description": "Read a resource from the server",
      "descriptor": {
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirReadCustomizer"
        ],
        "inputDataShape": {
          "kind": "java",
          "name": "ResourceId",
          "type": "io.syndesis.connector.fhir.FhirResourceId"
        },
        "outputDataShape": {
          "kind": "xml-schema"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the resource id and type to read",
            "name": "Read resource from the server",
            "properties": {
              "containedResourceTypes": {
                "deprecated": false,
                "displayName": "Contained Resource Types",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The optional resource types, which may be contained within a resource",
                "multiple": true,
                "order": "2",
                "required": false,
                "secret": false,
                "type": "select"
              },
              "id": {
                "deprecated": false,
                "displayName": "Resource Id",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource id, e.g. \"123\"",
                "order": "3",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "resourceType": {
                "deprecated": false,
                "displayName": "Resource Type",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource type e.g \"Patient\", checkout http://hl7.org/implement/standards/fhir/resourcelist.html",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "select"
              },
              "version": {
                "deprecated": false,
                "displayName": "Resource version",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The version e.g \"123\" (used with Id only)",
                "order": "4",
                "required": false,
                "secret": false,
                "type": "string"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-read-connector",
      "name": "Read",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    },
    {
      "actionType": "connector",
      "description": "Search for resources on the server",
      "descriptor": {
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirSearchCustomizer"
        ],
        "inputDataShape": {
          "kind": "java",
          "name": "ResourceQuery",
          "type": "io.syndesis.connector.fhir.FhirResourceQuery"
        },
        "outputDataShape": {
          "kind": "xml-schema"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the resource type and the query, e.g. \"given=Vincent&family=Freeman\"",
            "name": "Search for resources on the server",
            "properties": {
              "query": {
                "deprecated": false,
                "displayName": "Query",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The query, e.g. \"given=Vincent&family=Freeman\"",
                "order": "2",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "resourceType": {
                "deprecated": false,
                "displayName": "Resource Type",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource type to query",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "select"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-search-connector",
      "name": "Search",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    },
    {
      "actionType": "connector",
      "description": "Delete a resource from the server",
      "descriptor": {
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirDeleteCustomizer"
        ],
        "inputDataShape": {
          "kind": "java",
          "name": "ResourceId",
          "type": "io.syndesis.connector.fhir.FhirResourceId"
        },
        "outputDataShape": {
          "kind": "java",
          "name": "Outcome",
          "type": "ca.uhn.fhir.rest.api.MethodOutcome"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the resource id and type to delete",
            "name": "Delete resource from the server",
            "properties": {
              "id": {
                "deprecated": false,
                "displayName": "Resource Id",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource id, e.g. \"123\"",
                "order": "2",
                "required": false,
                "secret": false,
                "type": "string"
              },
              "resourceType": {
                "deprecated": false,
                "displayName": "Resource Type",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource type, e.g \"Patient\", checkout http://hl7.org/implement/standards/fhir/resourcelist.html",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "String"
              },
              "version": {
                "deprecated": false,
                "displayName": "Resource version",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The optional version e.g \"123\"",
                "order": "3",
                "required": false,
                "secret": false,
                "type": "String"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-delete-connector",
      "name": "Delete",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    },
    {
      "actionType": "connector",
      "description": "Update all fields or create a resource with defined ID on the server",
      "descriptor": {
        "configuredProperties": {},
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirUpdateCustomizer"
        ],
        "inputDataShape": {
          "kind": "xml-schema"
        },
        "outputDataShape": {
          "kind": "java",
          "name": "Outcome",
          "type": "ca.uhn.fhir.rest.api.MethodOutcome"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the resource to update or create",
            "name": "Update all fields or create a resource with defined ID on the server",
            "properties": {
              "containedResourceTypes": {
                "deprecated": false,
                "displayName": "Contained Resource Types",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The optional resource types, which may be contained within a resource",
                "multiple": true,
                "order": "2",
                "required": false,
                "secret": false,
                "type": "select"
              },
              "resourceType": {
                "deprecated": false,
                "displayName": "Resource Type",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource type to update",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "String"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-update-connector",
      "name": "Update",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    },
    {
      "actionType": "connector",
      "description": "Update selected fields in a resource on the server",
      "descriptor": {
        "configuredProperties": {},
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirPatchCustomizer"
        ],
        "inputDataShape": {
          "kind": "none"
        },
        "outputDataShape": {
          "kind": "java",
          "name": "Outcome",
          "type": "ca.uhn.fhir.rest.api.MethodOutcome"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the JSON patch to execute",
            "name": "Update selected fields in a resource on the server",
            "properties": {
              "id": {
                "deprecated": false,
                "displayName": "Resource Id",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource Id",
                "order": "3",
                "required": false,
                "secret": false,
                "type": "String"
              },
              "operationNumber": {
                "defaultValue": 1,
                "deprecated": false,
                "displayName": "Number Of Operations",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The number of operations to be defined in the patch.",
                "order": "2",
                "required": true,
                "secret": false,
                "type": "number"
              },
              "patch": {
                "deprecated": false,
                "displayName": "JSON Patch",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The JSON patch to execute. Conforms to http://jsonpatch.com/",
                "order": "4",
                "placeholder": "e.g. [{ \"op\":\"replace\", \"path\":\"active\", \"value\":true }]",
                "required": false,
                "secret": false,
                "type": "textarea"
              },
              "resourceType": {
                "deprecated": false,
                "displayName": "Resource Type",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource type to query",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "select"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-patch-connector",
      "name": "Patch",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    },
    {
      "actionType": "connector",
      "description": "Create a resource on the server (with auto-generated ID)",
      "descriptor": {
        "configuredProperties": {},
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirCreateCustomizer"
        ],
        "inputDataShape": {
          "kind": "xml-schema"
        },
        "outputDataShape": {
          "kind": "java",
          "name": "Outcome",
          "type": "ca.uhn.fhir.rest.api.MethodOutcome"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the resource to create",
            "name": "Create a resource on the server (with auto-generated ID)",
            "properties": {
              "containedResourceTypes": {
                "deprecated": false,
                "displayName": "Contained Resource Types",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The optional resource types, which may be contained within a resource",
                "multiple": true,
                "order": "2",
                "required": false,
                "secret": false,
                "type": "select"
              },
              "resourceType": {
                "deprecated": false,
                "displayName": "Resource Type",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource type to create",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "String"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-create-connector",
      "name": "Create",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    },
    {
      "actionType": "connector",
      "description": "Run a list of actions in a single transaction",
      "descriptor": {
        "configuredProperties": {},
        "connectorCustomizers": [
          "io.syndesis.connector.fhir.customizer.FhirTransactionCustomizer"
        ],
        "inputDataShape": {
          "kind": "xml-schema"
        },
        "outputDataShape": {
          "kind": "xml-schema"
        },
        "propertyDefinitionSteps": [
          {
            "description": "Specify the resources to include in a transaction",
            "name": "Create a number of resources in a single transaction",
            "properties": {
              "containedResourceTypes": {
                "deprecated": false,
                "displayName": "Included Resource Types",
                "group": "common",
                "javaType": "java.lang.String",
                "kind": "parameter",
                "labelHint": "The resource types to include in a transaction",
                "multiple": "true",
                "order": "1",
                "required": true,
                "secret": false,
                "type": "select"
              }
            }
          }
        ]
      },
      "id": "io.syndesis:fhir-transaction-connector",
      "name": "Transaction",
      "pattern": "To",
      "tags": [
        "dynamic"
      ]
    }
  ],
  "componentScheme": "fhir",
  "configuredProperties": {},
  "dependencies": [
    {
      "id": "@project.groupId@:@project.artifactId@:@project.version@",
      "type": "MAVEN"
    }
  ],
  "description": "Communicate with a FHIR server.",
  "icon": "assets:fhir.svg",
  "id": "fhir",
  "name": "FHIR",
  "properties": {
    "accessToken": {
      "defaultValue": "",
      "deprecated": false,
      "displayName": "FHIR server bearer token",
      "group": "security",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "The bearer token to use for bearer authentication (as specified in OAuth 2.0)",
      "order": "5",
      "required": false,
      "secret": true,
      "type": "string"
    },
    "fhirVersion": {
      "defaultValue": "DSTU3",
      "deprecated": false,
      "displayName": "FHIR version",
      "enum": [
        {
          "label": "DSTU3",
          "value": "DSTU3"
        }
      ],
      "group": "common",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "The FHIR version to use. Only DSTU3 is currently supported.",
      "order": "1",
      "required": true,
      "secret": false,
      "type": "string"
    },
    "password": {
      "defaultValue": "",
      "deprecated": false,
      "displayName": "FHIR server password",
      "group": "security",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "The password to use for basic authentication",
      "order": "4",
      "required": false,
      "secret": true,
      "type": "string"
    },
    "serverUrl": {
      "defaultValue": "http://fhirtest.uhn.ca/baseDstu3",
      "deprecated": false,
      "displayName": "FHIR server URL",
      "group": "common",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "The base URL of your FHIR server",
      "order": "2",
      "required": true,
      "secret": false,
      "type": "string"
    },
    "username": {
      "defaultValue": "",
      "deprecated": false,
      "displayName": "FHIR server username",
      "group": "security",
      "javaType": "java.lang.String",
      "kind": "parameter",
      "labelHint": "The username to use for basic authentication",
      "order": "3",
      "required": false,
      "secret": false,
      "type": "string"
    }
  },
  "tags": [
    "verifier"
  ]
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy