Jump to

• Request
• Response

Create a procedure

post

https://{domain_name}.ohms.oracle.com/ords/esi_api/api/v1/procedures

Creates a procedure in Oracle Health Immunization Management Cloud Service. Required and optional fields vary, depending on the tenant configuration. This method ignores populated fields that the calling tenant does not use.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

• application/json

Root Schema : schema

Match All

Show Source

• object ProceduresRequest
  Title: ProceduresRequest
• Example: { "procedure_code":123455, "registrant_code":"Ynwjdescan", "product_name":"BNT162b2", "product_lot_number":null, "product_lot_expiry_date":null, "product_dose_ml":null, "product_dose_number":null, "product_constitution_date":null, "waste_ml":null, "waste_reason":null, "administered_route":"IMR1", "administered_site":"LD", "procedure_outcome":"ADMEXT", "vaccine_info_sheet_provided_yn":null, "administered_on":null, "administered_date":"2023-03-21T00:00:00", "external_administered_date":"2023-03-21T00:00:00", "not_administered":null, "notes":"Test 123", "coadministered_yn":"N", "survey_consent_yn":"Y", "pr_src":null, "pregnancy":null, "appointment_time":null, "appointment_date":null, "location_code":"CTL2", "external_id":"30March202303c55" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ProceduresRequest"
        },
        {
            "example":{
                "procedure_code":123455,
                "registrant_code":"Ynwjdescan",
                "product_name":"BNT162b2",
                "product_lot_number":null,
                "product_lot_expiry_date":null,
                "product_dose_ml":null,
                "product_dose_number":null,
                "product_constitution_date":null,
                "waste_ml":null,
                "waste_reason":null,
                "administered_route":"IMR1",
                "administered_site":"LD",
                "procedure_outcome":"ADMEXT",
                "vaccine_info_sheet_provided_yn":null,
                "administered_on":null,
                "administered_date":"2023-03-21T00:00:00",
                "external_administered_date":"2023-03-21T00:00:00",
                "not_administered":null,
                "notes":"Test 123",
                "coadministered_yn":"N",
                "survey_consent_yn":"Y",
                "pr_src":null,
                "pregnancy":null,
                "appointment_time":null,
                "appointment_date":null,
                "location_code":"CTL2",
                "external_id":"30March202303c55"
            }
        }
    ]
}

Nested Schema : ProceduresRequest

Type: object

Title: ProceduresRequest

Show Source

• administered_date(required): string
• administered_on(required): string
• administered_route(required): string
• administered_site(required): string
• appointment_date(required): string
• appointment_time(required): string
• coadministered_yn(required): string
• external_id(required): string
• location_code(required): string
• not_administered(required): string
• pr_src(required): string
• pregnancy(required): string
• procedure_code(required): integer (int32)
• procedure_outcome(required): string
• product_category(required): string
• product_constitution_date(required): string
• product_cvx(required): string
• product_disease_name(required): string
• product_dose_ml(required): integer (int32)
• product_dose_number(required): integer (int32)
• product_expiry_date(required): string
• product_lot_number(required): string
• product_manufacturer(required): string
• product_mvx(required): string
• product_name(required): string
• registrant_code(required): integer (int32)
• survey_consent_yn(required): string
• vaccine_info_sheet_provided_yn(required): string
• waste_ml(required): string
• waste_reason(required): string

{
    "title":"ProceduresRequest",
    "required":[
        "procedure_code",
        "registrant_code",
        "product_manufacturer",
        "product_mvx",
        "product_category",
        "product_name",
        "product_cvx",
        "product_disease_name",
        "product_lot_number",
        "product_expiry_date",
        "product_dose_ml",
        "product_dose_number",
        "product_constitution_date",
        "waste_ml",
        "waste_reason",
        "administered_route",
        "administered_site",
        "procedure_outcome",
        "vaccine_info_sheet_provided_yn",
        "administered_on",
        "administered_date",
        "not_administered",
        "coadministered_yn",
        "survey_consent_yn",
        "pr_src",
        "pregnancy",
        "appointment_time",
        "appointment_date",
        "location_code",
        "external_id"
    ],
    "type":"object",
    "properties":{
        "procedure_code":{
            "type":"integer",
            "format":"int32"
        },
        "registrant_code":{
            "type":"integer",
            "format":"int32"
        },
        "product_manufacturer":{
            "type":"string"
        },
        "product_mvx":{
            "type":"string"
        },
        "product_category":{
            "type":"string"
        },
        "product_name":{
            "type":"string"
        },
        "product_cvx":{
            "type":"string",
            "nullable":true
        },
        "product_disease_name":{
            "type":"string"
        },
        "product_lot_number":{
            "type":"string",
            "nullable":true
        },
        "product_expiry_date":{
            "type":"string"
        },
        "product_dose_ml":{
            "type":"integer",
            "format":"int32"
        },
        "product_dose_number":{
            "type":"integer",
            "format":"int32"
        },
        "product_constitution_date":{
            "type":"string"
        },
        "waste_ml":{
            "type":"string"
        },
        "waste_reason":{
            "type":"string",
            "nullable":true
        },
        "administered_route":{
            "type":"string",
            "nullable":true
        },
        "administered_site":{
            "type":"string",
            "nullable":true
        },
        "procedure_outcome":{
            "type":"string"
        },
        "vaccine_info_sheet_provided_yn":{
            "type":"string"
        },
        "administered_on":{
            "type":"string"
        },
        "administered_date":{
            "type":"string"
        },
        "not_administered":{
            "type":"string",
            "nullable":true
        },
        "coadministered_yn":{
            "type":"string"
        },
        "survey_consent_yn":{
            "type":"string"
        },
        "pr_src":{
            "type":"string"
        },
        "pregnancy":{
            "type":"string"
        },
        "appointment_time":{
            "type":"string"
        },
        "appointment_date":{
            "type":"string"
        },
        "location_code":{
            "type":"string"
        },
        "external_id":{
            "type":"string"
        }
    },
    "example":{
        "procedure_code":1234,
        "registrant_code":2.742317216293884E38,
        "product_manufacturer":"XXX",
        "product_mvx":"XXX",
        "product_category":"VACCINE",
        "product_name":"AZD1222",
        "product_cvx":null,
        "product_disease_name":"aaa",
        "product_lot_number":null,
        "product_expiry_date":"2021-10-06T00:00:00",
        "product_dose_ml":1234,
        "product_dose_number":1234,
        "product_constitution_date":"2021-10-06T00:00:00",
        "waste_ml":"123",
        "waste_reason":null,
        "administered_route":null,
        "administered_site":null,
        "procedure_outcome":"ADM",
        "vaccine_info_sheet_provided_yn":"N",
        "administered_on":"2023-02-06T00:00:00",
        "administered_date":"2023-02-06T00:00:00",
        "not_administered":null,
        "coadministered_yn":"N",
        "survey_consent_yn":"Y",
        "pr_src":"SR",
        "pregnancy":"N",
        "appointment_time":"2021-10-06T14:33:24.673310Z",
        "appointment_date":"2021-10-06T00:00:00",
        "location_code":"GA",
        "external_id":"27020230811"
    }
}

Example:

{
    "procedure_code":1234,
    "registrant_code":2.742317216293884E38,
    "product_manufacturer":"XXX",
    "product_mvx":"XXX",
    "product_category":"VACCINE",
    "product_name":"AZD1222",
    "product_cvx":null,
    "product_disease_name":"aaa",
    "product_lot_number":null,
    "product_expiry_date":"2021-10-06T00:00:00",
    "product_dose_ml":1234,
    "product_dose_number":1234,
    "product_constitution_date":"2021-10-06T00:00:00",
    "waste_ml":"123",
    "waste_reason":null,
    "administered_route":null,
    "administered_site":null,
    "procedure_outcome":"ADM",
    "vaccine_info_sheet_provided_yn":"N",
    "administered_on":"2023-02-06T00:00:00",
    "administered_date":"2023-02-06T00:00:00",
    "not_administered":null,
    "coadministered_yn":"N",
    "survey_consent_yn":"Y",
    "pr_src":"SR",
    "pregnancy":"N",
    "appointment_time":"2021-10-06T14:33:24.673310Z",
    "appointment_date":"2021-10-06T00:00:00",
    "location_code":"GA",
    "external_id":"27020230811"
}

Security

• bearer(required): http
  Type: http

Back to Top

Response

200 Response

Back to Top