Jump to

• Request
• Response

Update coded verbatim terms in DCS

put

/ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/codedValues

Updates coded verbatim terms back in forms.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• auditInfo(required): object AUDITINFO
• autoCodeData(required): object AUTOCODEDATA
• trial(required): string

{
    "required":[
        "auditInfo",
        "autoCodeData",
        "trial"
    ],
    "type":"object",
    "properties":{
        "trial":{
            "type":"string",
            "xml":{
                "name":"TRIAL"
            }
        },
        "auditInfo":{
            "$ref":"#/components/schemas/AuditInfo"
        },
        "autoCodeData":{
            "$ref":"#/components/schemas/AutoCodeData"
        }
    },
    "xml":{
        "name":"PUTCODINGDATAREQ",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUDITINFO

Type: object

Show Source

• changeReason(required): string
• informUser(required): string

{
    "required":[
        "changeReason",
        "informUser"
    ],
    "type":"object",
    "properties":{
        "informUser":{
            "type":"string",
            "xml":{
                "name":"INFORMUSER"
            }
        },
        "changeReason":{
            "type":"string",
            "xml":{
                "name":"CHANGEREASON"
            }
        }
    },
    "xml":{
        "name":"AUDITINFO",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUTOCODEDATA

Type: object

Show Source

• autoCodeSet(required): array AUTOCODESET

{
    "required":[
        "autoCodeSet"
    ],
    "type":"object",
    "properties":{
        "autoCodeSet":{
            "type":"array",
            "xml":{
                "name":"AUTOCODESET"
            },
            "items":{
                "$ref":"#/components/schemas/AutoCodeSet"
            }
        }
    },
    "xml":{
        "name":"AUTOCODEDATA",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUTOCODESET

Type: array

Show Source

• Array of: object AutoCodeSet

{
    "type":"array",
    "xml":{
        "name":"AUTOCODESET"
    },
    "items":{
        "$ref":"#/components/schemas/AutoCodeSet"
    }
}

Nested Schema : AutoCodeSet

Type: object

Show Source

• autoCode: array AUTOCODE
• codeSetType: string

{
    "type":"object",
    "properties":{
        "autoCode":{
            "type":"array",
            "xml":{
                "name":"AUTOCODE"
            },
            "items":{
                "$ref":"#/components/schemas/AutoCode"
            }
        },
        "codeSetType":{
            "type":"string",
            "xml":{
                "name":"CODESETTYPE",
                "attribute":true
            }
        }
    }
}

Nested Schema : AUTOCODE

Type: array

Show Source

• Array of: object AUTOCODE

{
    "type":"array",
    "xml":{
        "name":"AUTOCODE"
    },
    "items":{
        "$ref":"#/components/schemas/AutoCode"
    }
}

Nested Schema : AUTOCODE

Type: object

Show Source

• contextInfo: object CONTEXTINFORMATION
• deleted: boolean
• dictionary: object DICTIONARY
• patientContext(required): object PATIENTCONTEXT
• sourceContext(required): object SOURCECONTEXT
• targetContext(required): object TARGETCONTEXT
• verbatim: string
• verbatimType: string

{
    "required":[
        "patientContext",
        "sourceContext",
        "targetContext"
    ],
    "type":"object",
    "properties":{
        "dictionary":{
            "$ref":"#/components/schemas/Dictionary"
        },
        "patientContext":{
            "$ref":"#/components/schemas/PatientContext"
        },
        "sourceContext":{
            "$ref":"#/components/schemas/SourceContext"
        },
        "targetContext":{
            "$ref":"#/components/schemas/TargetContext"
        },
        "verbatim":{
            "type":"string",
            "xml":{
                "name":"VERBATIM",
                "attribute":true
            }
        },
        "verbatimType":{
            "type":"string",
            "xml":{
                "name":"VERBATIMTYPE",
                "attribute":true
            }
        },
        "deleted":{
            "type":"boolean",
            "xml":{
                "name":"DELETED",
                "attribute":true
            }
        },
        "contextInfo":{
            "$ref":"#/components/schemas/ContextInformation"
        }
    },
    "xml":{
        "name":"AUTOCODE",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTEXTINFORMATION

Type: object

Show Source

• contextItem: array CONTEXTITEM

{
    "type":"object",
    "properties":{
        "contextItem":{
            "type":"array",
            "xml":{
                "name":"CONTEXTITEM"
            },
            "items":{
                "$ref":"#/components/schemas/ContextItem"
            }
        }
    },
    "xml":{
        "name":"CONTEXTINFORMATION",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : DICTIONARY

Type: object

Show Source

• culture: string
• type: string
• version: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "xml":{
                "name":"TYPE",
                "attribute":true
            }
        },
        "version":{
            "type":"string",
            "xml":{
                "name":"VERSION",
                "attribute":true
            }
        },
        "culture":{
            "type":"string",
            "xml":{
                "name":"CULTURE",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"DICTIONARY",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : PATIENTCONTEXT

Type: object

Show Source

• guid: string
• initials(required): string
• patientNumber(required): string
• site(required): object SITE

{
    "required":[
        "initials",
        "patientNumber",
        "site"
    ],
    "type":"object",
    "properties":{
        "patientNumber":{
            "type":"string",
            "xml":{
                "name":"PATIENTNUMBER"
            }
        },
        "initials":{
            "type":"string",
            "xml":{
                "name":"INITIALS"
            }
        },
        "site":{
            "$ref":"#/components/schemas/Site"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"PATIENTCONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SOURCECONTEXT

Type: object

Show Source

• formSetRef(required): object FORMSETREF
• informUrl(required): string
• sourceId: string

{
    "required":[
        "formSetRef",
        "informUrl"
    ],
    "type":"object",
    "properties":{
        "informUrl":{
            "type":"string",
            "xml":{
                "name":"INFORMURL"
            }
        },
        "formSetRef":{
            "$ref":"#/components/schemas/FormSetRef"
        },
        "sourceId":{
            "type":"string",
            "xml":{
                "name":"SOURCEID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SOURCECONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : TARGETCONTEXT

Type: object

Show Source

• targetItem: array TARGETITEM
• targetItems: array targetItems

{
    "type":"object",
    "properties":{
        "targetItem":{
            "type":"array",
            "xml":{
                "name":"TARGETITEM"
            },
            "items":{
                "$ref":"#/components/schemas/TargetItem"
            }
        },
        "targetItems":{
            "type":"array",
            "writeOnly":true,
            "items":{
                "$ref":"#/components/schemas/TargetItem"
            }
        }
    },
    "xml":{
        "name":"TARGETCONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTEXTITEM

Type: array

Show Source

• Array of: object CONTEXTITEM

{
    "type":"array",
    "xml":{
        "name":"CONTEXTITEM"
    },
    "items":{
        "$ref":"#/components/schemas/ContextItem"
    }
}

Nested Schema : CONTEXTITEM

Type: object

Show Source

• name: string
• value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"CONTEXTITEM",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SITE

Type: object

Show Source

• guid: string
• mnemonic: string
• name: string

{
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "mnemonic":{
            "type":"string",
            "xml":{
                "name":"MNEMONIC",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SITE",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : FORMSETREF

Type: object

Show Source

• formRef(required): object FormRef
  FormRef metadata
• guid: string
• name: string
• order: integer (int64)
• refName: string
• revision: number (float)

{
    "required":[
        "formRef"
    ],
    "type":"object",
    "properties":{
        "formRef":{
            "$ref":"#/components/schemas/FormRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "order":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"ORDER",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"FORMSETREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : FormRef

Type: object

FormRef metadata

Show Source

• collectionExceptionConditionOID: string
  OID for collection exception

  Example: 43caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
• formOID: string
  OID of the referenced form

  Example: 33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
• mandatory: string
  Allowed Values: [ "Yes", "No" ]

  Is this form mandatory in the event?

  Example: Yes
• orderNumber: integer (int32)
  Order of this form in the event

  Example: 1

{
    "type":"object",
    "properties":{
        "formOID":{
            "type":"string",
            "description":"OID of the referenced form",
            "example":"33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order of this form in the event",
            "format":"int32",
            "example":1
        },
        "mandatory":{
            "type":"string",
            "description":"Is this form mandatory in the event?",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "description":"OID for collection exception",
            "example":"43caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29"
        }
    },
    "description":"FormRef metadata"
}

Nested Schema : TARGETITEM

Type: array

Show Source

• Array of: object TARGETITEM

{
    "type":"array",
    "xml":{
        "name":"TARGETITEM"
    },
    "items":{
        "$ref":"#/components/schemas/TargetItem"
    }
}

Nested Schema : targetItems

Type: array

Show Source

• Array of: object TARGETITEM

{
    "type":"array",
    "writeOnly":true,
    "items":{
        "$ref":"#/components/schemas/TargetItem"
    }
}

Nested Schema : TARGETITEM

Type: object

Show Source

• codemapKey: string
• codeValue: string
• deleted: boolean
• formSetRef(required): object FORMSETREF
• informUrl(required): string
• name: string

{
    "required":[
        "formSetRef",
        "informUrl"
    ],
    "type":"object",
    "properties":{
        "informUrl":{
            "type":"string",
            "xml":{
                "name":"INFORMURL"
            }
        },
        "formSetRef":{
            "$ref":"#/components/schemas/FormSetRef"
        },
        "codemapKey":{
            "type":"string",
            "xml":{
                "name":"CODEMAPKEY",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "codeValue":{
            "type":"string",
            "xml":{
                "name":"CODEVALUE",
                "attribute":true
            }
        },
        "deleted":{
            "type":"boolean",
            "xml":{
                "name":"DELETED",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"TARGETITEM",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Back to Top

Response

Supported Media Types

• application/xml

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object AUTOCODERESP

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AutoCodeResp"
    }
}

Nested Schema : AUTOCODERESP

Type: object

Show Source

• autoCodeData: object AUTOCODEDATA
• bookmark: string
• codeSetTypeList: object CODESETTYPELIST
• errorList: object ERRORLIST
• itemsEvaluated: integer (int32)

{
    "type":"object",
    "properties":{
        "codeSetTypeList":{
            "$ref":"#/components/schemas/CodeSetTypeList"
        },
        "autoCodeData":{
            "$ref":"#/components/schemas/AutoCodeData"
        },
        "errorList":{
            "$ref":"#/components/schemas/ErrorList"
        },
        "itemsEvaluated":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "name":"ItemsEvaluated",
                "attribute":true
            }
        },
        "bookmark":{
            "type":"string",
            "xml":{
                "name":"Bookmark",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"AUTOCODERESP",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUTOCODEDATA

Type: object

Show Source

• autoCodeSet(required): array AUTOCODESET

{
    "required":[
        "autoCodeSet"
    ],
    "type":"object",
    "properties":{
        "autoCodeSet":{
            "type":"array",
            "xml":{
                "name":"AUTOCODESET"
            },
            "items":{
                "$ref":"#/components/schemas/AutoCodeSet"
            }
        }
    },
    "xml":{
        "name":"AUTOCODEDATA",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CODESETTYPELIST

Type: object

Show Source

• codeSetType: array CODESETTYPE

{
    "type":"object",
    "properties":{
        "codeSetType":{
            "type":"array",
            "xml":{
                "name":"CODESETTYPE"
            },
            "items":{
                "$ref":"#/components/schemas/CodeSetType"
            }
        }
    },
    "xml":{
        "name":"CODESETTYPELIST",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : ERRORLIST

Type: object

Show Source

• error: array ERROR

{
    "type":"object",
    "properties":{
        "error":{
            "type":"array",
            "xml":{
                "name":"ERROR"
            },
            "items":{
                "$ref":"#/components/schemas/Error"
            }
        }
    },
    "xml":{
        "name":"ERRORLIST",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUTOCODESET

Type: array

Show Source

• Array of: object AutoCodeSet

{
    "type":"array",
    "xml":{
        "name":"AUTOCODESET"
    },
    "items":{
        "$ref":"#/components/schemas/AutoCodeSet"
    }
}

Nested Schema : AutoCodeSet

Type: object

Show Source

• autoCode: array AUTOCODE
• codeSetType: string

{
    "type":"object",
    "properties":{
        "autoCode":{
            "type":"array",
            "xml":{
                "name":"AUTOCODE"
            },
            "items":{
                "$ref":"#/components/schemas/AutoCode"
            }
        },
        "codeSetType":{
            "type":"string",
            "xml":{
                "name":"CODESETTYPE",
                "attribute":true
            }
        }
    }
}

Nested Schema : AUTOCODE

Type: array

Show Source

• Array of: object AUTOCODE

{
    "type":"array",
    "xml":{
        "name":"AUTOCODE"
    },
    "items":{
        "$ref":"#/components/schemas/AutoCode"
    }
}

Nested Schema : AUTOCODE

Type: object

Show Source

• contextInfo: object CONTEXTINFORMATION
• deleted: boolean
• dictionary: object DICTIONARY
• patientContext(required): object PATIENTCONTEXT
• sourceContext(required): object SOURCECONTEXT
• targetContext(required): object TARGETCONTEXT
• verbatim: string
• verbatimType: string

{
    "required":[
        "patientContext",
        "sourceContext",
        "targetContext"
    ],
    "type":"object",
    "properties":{
        "dictionary":{
            "$ref":"#/components/schemas/Dictionary"
        },
        "patientContext":{
            "$ref":"#/components/schemas/PatientContext"
        },
        "sourceContext":{
            "$ref":"#/components/schemas/SourceContext"
        },
        "targetContext":{
            "$ref":"#/components/schemas/TargetContext"
        },
        "verbatim":{
            "type":"string",
            "xml":{
                "name":"VERBATIM",
                "attribute":true
            }
        },
        "verbatimType":{
            "type":"string",
            "xml":{
                "name":"VERBATIMTYPE",
                "attribute":true
            }
        },
        "deleted":{
            "type":"boolean",
            "xml":{
                "name":"DELETED",
                "attribute":true
            }
        },
        "contextInfo":{
            "$ref":"#/components/schemas/ContextInformation"
        }
    },
    "xml":{
        "name":"AUTOCODE",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTEXTINFORMATION

Type: object

Show Source

• contextItem: array CONTEXTITEM

{
    "type":"object",
    "properties":{
        "contextItem":{
            "type":"array",
            "xml":{
                "name":"CONTEXTITEM"
            },
            "items":{
                "$ref":"#/components/schemas/ContextItem"
            }
        }
    },
    "xml":{
        "name":"CONTEXTINFORMATION",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : DICTIONARY

Type: object

Show Source

• culture: string
• type: string
• version: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "xml":{
                "name":"TYPE",
                "attribute":true
            }
        },
        "version":{
            "type":"string",
            "xml":{
                "name":"VERSION",
                "attribute":true
            }
        },
        "culture":{
            "type":"string",
            "xml":{
                "name":"CULTURE",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"DICTIONARY",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : PATIENTCONTEXT

Type: object

Show Source

• guid: string
• initials(required): string
• patientNumber(required): string
• site(required): object SITE

{
    "required":[
        "initials",
        "patientNumber",
        "site"
    ],
    "type":"object",
    "properties":{
        "patientNumber":{
            "type":"string",
            "xml":{
                "name":"PATIENTNUMBER"
            }
        },
        "initials":{
            "type":"string",
            "xml":{
                "name":"INITIALS"
            }
        },
        "site":{
            "$ref":"#/components/schemas/Site"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"PATIENTCONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SOURCECONTEXT

Type: object

Show Source

• formSetRef(required): object FORMSETREF
• informUrl(required): string
• sourceId: string

{
    "required":[
        "formSetRef",
        "informUrl"
    ],
    "type":"object",
    "properties":{
        "informUrl":{
            "type":"string",
            "xml":{
                "name":"INFORMURL"
            }
        },
        "formSetRef":{
            "$ref":"#/components/schemas/FormSetRef"
        },
        "sourceId":{
            "type":"string",
            "xml":{
                "name":"SOURCEID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SOURCECONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : TARGETCONTEXT

Type: object

Show Source

• targetItem: array TARGETITEM
• targetItems: array targetItems

{
    "type":"object",
    "properties":{
        "targetItem":{
            "type":"array",
            "xml":{
                "name":"TARGETITEM"
            },
            "items":{
                "$ref":"#/components/schemas/TargetItem"
            }
        },
        "targetItems":{
            "type":"array",
            "writeOnly":true,
            "items":{
                "$ref":"#/components/schemas/TargetItem"
            }
        }
    },
    "xml":{
        "name":"TARGETCONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTEXTITEM

Type: array

Show Source

• Array of: object CONTEXTITEM

{
    "type":"array",
    "xml":{
        "name":"CONTEXTITEM"
    },
    "items":{
        "$ref":"#/components/schemas/ContextItem"
    }
}

Nested Schema : CONTEXTITEM

Type: object

Show Source

• name: string
• value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"CONTEXTITEM",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SITE

Type: object

Show Source

• guid: string
• mnemonic: string
• name: string

{
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "mnemonic":{
            "type":"string",
            "xml":{
                "name":"MNEMONIC",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SITE",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : FORMSETREF

Type: object

Show Source

• formRef(required): object FormRef
  FormRef metadata
• guid: string
• name: string
• order: integer (int64)
• refName: string
• revision: number (float)

{
    "required":[
        "formRef"
    ],
    "type":"object",
    "properties":{
        "formRef":{
            "$ref":"#/components/schemas/FormRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "order":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"ORDER",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"FORMSETREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : FormRef

Type: object

FormRef metadata

Show Source

• collectionExceptionConditionOID: string
  OID for collection exception

  Example: 43caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
• formOID: string
  OID of the referenced form

  Example: 33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
• mandatory: string
  Allowed Values: [ "Yes", "No" ]

  Is this form mandatory in the event?

  Example: Yes
• orderNumber: integer (int32)
  Order of this form in the event

  Example: 1

{
    "type":"object",
    "properties":{
        "formOID":{
            "type":"string",
            "description":"OID of the referenced form",
            "example":"33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order of this form in the event",
            "format":"int32",
            "example":1
        },
        "mandatory":{
            "type":"string",
            "description":"Is this form mandatory in the event?",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "description":"OID for collection exception",
            "example":"43caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29"
        }
    },
    "description":"FormRef metadata"
}

Nested Schema : TARGETITEM

Type: array

Show Source

• Array of: object TARGETITEM

{
    "type":"array",
    "xml":{
        "name":"TARGETITEM"
    },
    "items":{
        "$ref":"#/components/schemas/TargetItem"
    }
}

Nested Schema : targetItems

Type: array

Show Source

• Array of: object TARGETITEM

{
    "type":"array",
    "writeOnly":true,
    "items":{
        "$ref":"#/components/schemas/TargetItem"
    }
}

Nested Schema : TARGETITEM

Type: object

Show Source

• codemapKey: string
• codeValue: string
• deleted: boolean
• formSetRef(required): object FORMSETREF
• informUrl(required): string
• name: string

{
    "required":[
        "formSetRef",
        "informUrl"
    ],
    "type":"object",
    "properties":{
        "informUrl":{
            "type":"string",
            "xml":{
                "name":"INFORMURL"
            }
        },
        "formSetRef":{
            "$ref":"#/components/schemas/FormSetRef"
        },
        "codemapKey":{
            "type":"string",
            "xml":{
                "name":"CODEMAPKEY",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "codeValue":{
            "type":"string",
            "xml":{
                "name":"CODEVALUE",
                "attribute":true
            }
        },
        "deleted":{
            "type":"boolean",
            "xml":{
                "name":"DELETED",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"TARGETITEM",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CODESETTYPE

Type: array

Show Source

• Array of: object CodeSetType

{
    "type":"array",
    "xml":{
        "name":"CODESETTYPE"
    },
    "items":{
        "$ref":"#/components/schemas/CodeSetType"
    }
}

Nested Schema : CodeSetType

Type: object

Show Source

• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object Error

{
    "type":"array",
    "xml":{
        "name":"ERROR"
    },
    "items":{
        "$ref":"#/components/schemas/Error"
    }
}

Nested Schema : Error

Type: object

Show Source

• autoCode: object AUTOCODE
• description(required): string

{
    "required":[
        "description"
    ],
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "xml":{
                "name":"DESCRIPTION"
            }
        },
        "autoCode":{
            "$ref":"#/components/schemas/AutoCode"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : AUTOCODERESP

Type: object

Show Source

• autoCodeData: object AUTOCODEDATA
• bookmark: string
• codeSetTypeList: object CODESETTYPELIST
• errorList: object ERRORLIST
• itemsEvaluated: integer (int32)

{
    "type":"object",
    "properties":{
        "codeSetTypeList":{
            "$ref":"#/components/schemas/CodeSetTypeList"
        },
        "autoCodeData":{
            "$ref":"#/components/schemas/AutoCodeData"
        },
        "errorList":{
            "$ref":"#/components/schemas/ErrorList"
        },
        "itemsEvaluated":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "name":"ItemsEvaluated",
                "attribute":true
            }
        },
        "bookmark":{
            "type":"string",
            "xml":{
                "name":"Bookmark",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"AUTOCODERESP",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUTOCODEDATA

Type: object

Show Source

• autoCodeSet(required): array AUTOCODESET

{
    "required":[
        "autoCodeSet"
    ],
    "type":"object",
    "properties":{
        "autoCodeSet":{
            "type":"array",
            "xml":{
                "name":"AUTOCODESET"
            },
            "items":{
                "$ref":"#/components/schemas/AutoCodeSet"
            }
        }
    },
    "xml":{
        "name":"AUTOCODEDATA",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CODESETTYPELIST

Type: object

Show Source

• codeSetType: array CODESETTYPE

{
    "type":"object",
    "properties":{
        "codeSetType":{
            "type":"array",
            "xml":{
                "name":"CODESETTYPE"
            },
            "items":{
                "$ref":"#/components/schemas/CodeSetType"
            }
        }
    },
    "xml":{
        "name":"CODESETTYPELIST",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : ERRORLIST

Type: object

Show Source

• error: array ERROR

{
    "type":"object",
    "properties":{
        "error":{
            "type":"array",
            "xml":{
                "name":"ERROR"
            },
            "items":{
                "$ref":"#/components/schemas/Error"
            }
        }
    },
    "xml":{
        "name":"ERRORLIST",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : AUTOCODESET

Type: array

Show Source

• Array of: object AutoCodeSet

{
    "type":"array",
    "xml":{
        "name":"AUTOCODESET"
    },
    "items":{
        "$ref":"#/components/schemas/AutoCodeSet"
    }
}

Nested Schema : AutoCodeSet

Type: object

Show Source

• autoCode: array AUTOCODE
• codeSetType: string

{
    "type":"object",
    "properties":{
        "autoCode":{
            "type":"array",
            "xml":{
                "name":"AUTOCODE"
            },
            "items":{
                "$ref":"#/components/schemas/AutoCode"
            }
        },
        "codeSetType":{
            "type":"string",
            "xml":{
                "name":"CODESETTYPE",
                "attribute":true
            }
        }
    }
}

Nested Schema : AUTOCODE

Type: array

Show Source

• Array of: object AUTOCODE

{
    "type":"array",
    "xml":{
        "name":"AUTOCODE"
    },
    "items":{
        "$ref":"#/components/schemas/AutoCode"
    }
}

Nested Schema : AUTOCODE

Type: object

Show Source

• contextInfo: object CONTEXTINFORMATION
• deleted: boolean
• dictionary: object DICTIONARY
• patientContext(required): object PATIENTCONTEXT
• sourceContext(required): object SOURCECONTEXT
• targetContext(required): object TARGETCONTEXT
• verbatim: string
• verbatimType: string

{
    "required":[
        "patientContext",
        "sourceContext",
        "targetContext"
    ],
    "type":"object",
    "properties":{
        "dictionary":{
            "$ref":"#/components/schemas/Dictionary"
        },
        "patientContext":{
            "$ref":"#/components/schemas/PatientContext"
        },
        "sourceContext":{
            "$ref":"#/components/schemas/SourceContext"
        },
        "targetContext":{
            "$ref":"#/components/schemas/TargetContext"
        },
        "verbatim":{
            "type":"string",
            "xml":{
                "name":"VERBATIM",
                "attribute":true
            }
        },
        "verbatimType":{
            "type":"string",
            "xml":{
                "name":"VERBATIMTYPE",
                "attribute":true
            }
        },
        "deleted":{
            "type":"boolean",
            "xml":{
                "name":"DELETED",
                "attribute":true
            }
        },
        "contextInfo":{
            "$ref":"#/components/schemas/ContextInformation"
        }
    },
    "xml":{
        "name":"AUTOCODE",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTEXTINFORMATION

Type: object

Show Source

• contextItem: array CONTEXTITEM

{
    "type":"object",
    "properties":{
        "contextItem":{
            "type":"array",
            "xml":{
                "name":"CONTEXTITEM"
            },
            "items":{
                "$ref":"#/components/schemas/ContextItem"
            }
        }
    },
    "xml":{
        "name":"CONTEXTINFORMATION",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : DICTIONARY

Type: object

Show Source

• culture: string
• type: string
• version: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "xml":{
                "name":"TYPE",
                "attribute":true
            }
        },
        "version":{
            "type":"string",
            "xml":{
                "name":"VERSION",
                "attribute":true
            }
        },
        "culture":{
            "type":"string",
            "xml":{
                "name":"CULTURE",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"DICTIONARY",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : PATIENTCONTEXT

Type: object

Show Source

• guid: string
• initials(required): string
• patientNumber(required): string
• site(required): object SITE

{
    "required":[
        "initials",
        "patientNumber",
        "site"
    ],
    "type":"object",
    "properties":{
        "patientNumber":{
            "type":"string",
            "xml":{
                "name":"PATIENTNUMBER"
            }
        },
        "initials":{
            "type":"string",
            "xml":{
                "name":"INITIALS"
            }
        },
        "site":{
            "$ref":"#/components/schemas/Site"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"PATIENTCONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SOURCECONTEXT

Type: object

Show Source

• formSetRef(required): object FORMSETREF
• informUrl(required): string
• sourceId: string

{
    "required":[
        "formSetRef",
        "informUrl"
    ],
    "type":"object",
    "properties":{
        "informUrl":{
            "type":"string",
            "xml":{
                "name":"INFORMURL"
            }
        },
        "formSetRef":{
            "$ref":"#/components/schemas/FormSetRef"
        },
        "sourceId":{
            "type":"string",
            "xml":{
                "name":"SOURCEID",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SOURCECONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : TARGETCONTEXT

Type: object

Show Source

• targetItem: array TARGETITEM
• targetItems: array targetItems

{
    "type":"object",
    "properties":{
        "targetItem":{
            "type":"array",
            "xml":{
                "name":"TARGETITEM"
            },
            "items":{
                "$ref":"#/components/schemas/TargetItem"
            }
        },
        "targetItems":{
            "type":"array",
            "writeOnly":true,
            "items":{
                "$ref":"#/components/schemas/TargetItem"
            }
        }
    },
    "xml":{
        "name":"TARGETCONTEXT",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CONTEXTITEM

Type: array

Show Source

• Array of: object CONTEXTITEM

{
    "type":"array",
    "xml":{
        "name":"CONTEXTITEM"
    },
    "items":{
        "$ref":"#/components/schemas/ContextItem"
    }
}

Nested Schema : CONTEXTITEM

Type: object

Show Source

• name: string
• value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"CONTEXTITEM",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : SITE

Type: object

Show Source

• guid: string
• mnemonic: string
• name: string

{
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "mnemonic":{
            "type":"string",
            "xml":{
                "name":"MNEMONIC",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"SITE",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : FORMSETREF

Type: object

Show Source

• formRef(required): object FormRef
  FormRef metadata
• guid: string
• name: string
• order: integer (int64)
• refName: string
• revision: number (float)

{
    "required":[
        "formRef"
    ],
    "type":"object",
    "properties":{
        "formRef":{
            "$ref":"#/components/schemas/FormRef"
        },
        "guid":{
            "type":"string",
            "xml":{
                "name":"GUID",
                "attribute":true
            }
        },
        "revision":{
            "type":"number",
            "format":"float",
            "xml":{
                "name":"REVISION",
                "attribute":true
            }
        },
        "refName":{
            "type":"string",
            "xml":{
                "name":"REFNAME",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "order":{
            "type":"integer",
            "format":"int64",
            "xml":{
                "name":"ORDER",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"FORMSETREF",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : FormRef

Type: object

FormRef metadata

Show Source

• collectionExceptionConditionOID: string
  OID for collection exception

  Example: 43caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
• formOID: string
  OID of the referenced form

  Example: 33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
• mandatory: string
  Allowed Values: [ "Yes", "No" ]

  Is this form mandatory in the event?

  Example: Yes
• orderNumber: integer (int32)
  Order of this form in the event

  Example: 1

{
    "type":"object",
    "properties":{
        "formOID":{
            "type":"string",
            "description":"OID of the referenced form",
            "example":"33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order of this form in the event",
            "format":"int32",
            "example":1
        },
        "mandatory":{
            "type":"string",
            "description":"Is this form mandatory in the event?",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "collectionExceptionConditionOID":{
            "type":"string",
            "description":"OID for collection exception",
            "example":"43caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29"
        }
    },
    "description":"FormRef metadata"
}

Nested Schema : TARGETITEM

Type: array

Show Source

• Array of: object TARGETITEM

{
    "type":"array",
    "xml":{
        "name":"TARGETITEM"
    },
    "items":{
        "$ref":"#/components/schemas/TargetItem"
    }
}

Nested Schema : targetItems

Type: array

Show Source

• Array of: object TARGETITEM

{
    "type":"array",
    "writeOnly":true,
    "items":{
        "$ref":"#/components/schemas/TargetItem"
    }
}

Nested Schema : TARGETITEM

Type: object

Show Source

• codemapKey: string
• codeValue: string
• deleted: boolean
• formSetRef(required): object FORMSETREF
• informUrl(required): string
• name: string

{
    "required":[
        "formSetRef",
        "informUrl"
    ],
    "type":"object",
    "properties":{
        "informUrl":{
            "type":"string",
            "xml":{
                "name":"INFORMURL"
            }
        },
        "formSetRef":{
            "$ref":"#/components/schemas/FormSetRef"
        },
        "codemapKey":{
            "type":"string",
            "xml":{
                "name":"CODEMAPKEY",
                "attribute":true
            }
        },
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        },
        "codeValue":{
            "type":"string",
            "xml":{
                "name":"CODEVALUE",
                "attribute":true
            }
        },
        "deleted":{
            "type":"boolean",
            "xml":{
                "name":"DELETED",
                "attribute":true
            }
        }
    },
    "xml":{
        "name":"TARGETITEM",
        "namespace":"http://www.oracle.com/InFormAdapter/2011/10/Coding"
    }
}

Nested Schema : CODESETTYPE

Type: array

Show Source

• Array of: object CodeSetType

{
    "type":"array",
    "xml":{
        "name":"CODESETTYPE"
    },
    "items":{
        "$ref":"#/components/schemas/CodeSetType"
    }
}

Nested Schema : CodeSetType

Type: object

Show Source

• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "xml":{
                "name":"NAME",
                "attribute":true
            }
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object Error

{
    "type":"array",
    "xml":{
        "name":"ERROR"
    },
    "items":{
        "$ref":"#/components/schemas/Error"
    }
}

Nested Schema : Error

Type: object

Show Source

• autoCode: object AUTOCODE
• description(required): string

{
    "required":[
        "description"
    ],
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "xml":{
                "name":"DESCRIPTION"
            }
        },
        "autoCode":{
            "$ref":"#/components/schemas/AutoCode"
        }
    }
}

Back to Top