Skip to main content

Config for openmrs

Jobs that use the openmrs adaptor may require authentication. A "credential" for the openmrs adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "instanceUrl": "http://openmrs.com/instance/url"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "instanceUrl": {
          "title": "Instance URL",
          "type": "string",
          "description": "The OpenMRS host url",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "http://openmrs.com/instance/url"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "The username to log in to OpenMRS",
          "minLength": 1,
          "examples": [
              "admin@openmrs.org"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "The password to log in to OpenMRS",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@super(!)Secretpass"
          ]
      },
      "fhirVersion": {
          "title": "FHIR Release Version",
          "type": "string",
          "placeholder": "R4",
          "default": "R4",
          "description": "FHIR Release Version",
          "minLength": 1,
          "examples": [
              "R5",
              "R4B",
              "R4",
              "R3",
              "R2"
          ]
      },
      "tls": {
          "title": "TLS Options",
          "type": "object",
          "description": "TLS options to use for HTTPS requests. See https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions",
          "writeOnly": true,
          "examples": [
              {
                  "cert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1k3f4b2wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdTYW4gSm9zZTET\n-----END CERTIFICATE-----"
              }
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "instanceUrl"
  ]
}