Quick Start
Complete these tasks to set up your environment and use Oracle Health Immunization Management Cloud Service REST APIs to interact with your registrant and procedure data.
Prerequisites
| Prerequisite | More Information |
| Install cURL | Use cURL |
| Set up authentication | Authenticate |
Task 1: Sign in to Oracle Health Immunization Management Cloud Service
This documentation assumes that you have an Oracle Health Immunization Management Cloud Service account. For more information, see the Oracle Health Immunization Management Cloud Service User Guide.
Task 2: Get registrant data
Issue the following cURL command:
curl -X GET -H "Authorization: Bearer <app_access_token>" -H "Content-Type: application/json" -k "<base_url>/api/v1/registrants/<registrant_code>" --output <file_name>Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<registrant_code>is the code for a registrant, in numeric format<file_name>is the file name (for example,<output>.json)
An example of the output is as follows:
{
"registrants": [
{
"registrant_code": "Ofwhnmnlwj",
"first_name": "James",
"middle_name": "Thomas",
"last_name": "Wilson",
"dob": "1996-06-13T00:00:00",
"language_code": "en",
"contact_method": "EMAIL",
"phone": "7816434270",
"email": "hbvuhtlxcm.zufvwbctwr@dyn-blackhole.com",
"address_1": "Ajtzfgecvm",
"address_2": "Yzuxqsrcct",
"address_3": "Lcdcolphzo",
"address_4": "Kmcynvxmyq",
"postal_city": "Vyetbtipfj",
"postal_zone": "Dxtnmmhawc",
"sub_zone": "Forqzsdnxk",
"postal_code": "Gjwxjpnxyz",
"country_code": "SN",
"timezone": null,
"biological_sex": "MALE",
"gender": null,
"race": null,
"ethnicity": null,
"indigenous_status": null,
"created_on": "2021-03-15T21:03:31.032443Z",
"external_id": null,
"registrant_groups": [
{
"group_name": "Autres",
"group_description": "Autres",
"parent_group_name": null,
"parent_group_description": null
}
],
"registrant_documents": [
{
"document_type": null,
"document_subtype": null,
"document_uid": null
}
]
}
}Task 3: Create registrant data
Issue the following cURL command:
curl -X POST "<base_url>/api/v1/registrants" -H 'Authorization: Bearer <app_access_token>' -H 'Content-Type: application/json' -d '<input_json>'Where:
<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<app_access_token>is the value obtained from the access token, in alphanumeric format-
<input_json>is the JSON object to be passed. For example:{ "first_name" : "Jeremy", "middle_name" : null, "last_name" : "Smith", "contact_method" : "EMAIL", "calling_code_phone" : null, "phone" : null, "email" : "jeremy_smith@test.com", "address_1" : null, "address_2" : null, "address_3" : "address_3", "address_4" : "address_4", "postal_city" : "BAKEL", "postal_zone" : "DAKAR", "sub_zone" : "KOLDA", "postal_code" : null, "country_code" : "SN", "dob" : "1977-07-21T00:00:00", "biological_sex" : null, "gender" : null, "race" : null, "ethnicity" : null, "indigenous_status" : null, "external_id" : "1223444", "group_code": null, "registrant_documents": { "document_type": "NUMERO_PASSEPORT/CARTE_D'IDENT", "document_subtype": "PASSPORT", "document_uid": "12345678916" } }
A message displays, indicating that your request was successful.
Task 4: Update registrant data
Issue the following cURL command:
curl -X PUT "<base_url>/api/v1/registrants" -H 'Authorization: Bearer <app_access_token>' -H 'Content-Type: application/json' -d '<input_json>'Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service-
<input_json>is the JSON object to be passed. For example:{ "first_name" : "Jane", "middle_name" : "Mark", "last_name" : "Jones", "contact_method" : "EMAIL", "calling_code_phone" : null, "phone" : null, "email" : "jeremy_smith@test.com", "address_1" : null, "address_2" : null, "address_3" : "address_3", "address_4" : "address_4", "postal_city" : "BAKEL", "postal_zone" : "DAKAR", "sub_zone" : "DAKAR", "postal_code" : null, "country_code" : "SN", "dob" : "1977-07-21T00:00:00", "biological_sex" : null, "gender" : null, "race" : null, "ethnicity" : null, "indigenous_status" : null, "external_id" : "1223444", "group_code": "OKTGP55", "registrant_documents": { "document_type": "NUMERO_PASSEPORT/CARTE_D'IDENT", "document_subtype": "NATIONAL_ID", "document_uid": "12345678916" } }
A message displays, indicating that your request was successful.
Task 5: Get procedure data
Issue the following cURL command:
curl -X GET -H "Authorization: Bearer <app_access_token>" -H "Content-Type: application/json" -k "<base_url>/api/v1/procedures/<procedure_code>" --output <file_name>Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<procedure_code>is the code for a procedure, in numeric format<file_name>is the file name (for example,<output>.json)
An example of the output is as follows:
{
"procedure_id": 337856569127715256253401127727315705097,
"registrant_code": "SEN-11173-37505",
"registrant_external_id": null,
"procedure_external_id": null,
"product_manufacturer": "IPD (DAKAR)",
"product_mvx": "OTH",
"product_category": "VACCINE",
"product_name": "Yellow Fever IPD",
"product_cvx": null,
"product_disease_name": "Yellow Fever",
"product_lot_number": null,
"product_expiry_date": null,
"product_dose_ml": null,
"product_dose_number": 1,
"product_constitution_date": null,
"waste_ml": null,
"waste_reason": null,
"administered_route ": {
"return_value": null,
"display_value": null
},
"administered_site ": {
"return_value": null,
"display_value": null
},
"procedure_outcome ": {
"return_value": "ADMEXT",
"display_value": "Vaccin??"
},
"notes": "Notes",
"vaccine_info_sheet_provided_yn": "N",
"administered_by": "PERSON.NAME@ADDRESS.COM",
"administered_date": "2023-06-21T00:00:00.000000Z",
"not_administered_reason ": {
"return_value": "ANAPHYLAXIS",
"display_value": "Anaphylaxie;Allergies"
},
"coadministered_yn": null,
"survey_consent_yn": null,
"pr_src": "WI",
"appointment_duration": 15,
"appontment_number": 0,
"location_name": null,
"location_code": null,
"location_address_1": null,
"location_address_2": null,
"location_address_3": null,
"location_address_4": null,
"location_city": null,
"location_sub_zone": null,
"location_zone": null,
"location_postal_code": null,
"location_country_code": null,
"location_time_zone": null,
"location_contact_name": null,
"location_contact_email": null,
"location_contact_phone": null,
"location_clinical_setting": null,
"procedure_created_date": "2023-06-22T15:41:19.469363Z",
"procedure_updated_date": "2023-06-22T15:42:32.137033Z"
}Task 6: Create procedure data
Issue the following cURL command:
curl -X POST "<base_url>/api/v1/procedures" -H 'Authorization: Bearer <app_access_token>' -H 'Content-Type: application/json' -d '<input_json>'Where:
<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<app_access_token>is the value obtained from the access token, in alphanumeric format-
<input_json>is the JSON object to be passed. For 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" }
A message displays, indicating that your request was successful.
Task 7: Get location data
Issue the following cURL command:
curl -X GET -H "Authorization: Bearer <app_access_token>" -H "Content-Type: application/json" -k "<base_url>/api/v1/locations/<location_code>" --output <file_name>Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<location_code>is the code for the location, in numeric format<file_name>is the file name (for example,<output>.json)
An example of the output is as follows:
{
"location_name": "TEST Location DD E2Ee",
"location_code": "TESTLDDE2E",
"location_active_yn": "Y",
"location_address_3": "TESTve",
"location_address_4": "TESTce",
"location_city": "BAKEL",
"location_sub_zone": "BAKEL",
"location_zone": "DAKAR",
"location_country_code": "SN",
"location_time_zone": "Europe/Kiev",
"location_type": "HOSP_LVL_3"
}Task 8: Get lookups
Issue the following cURL command:
curl -X GET -H "Authorization: Bearer <app_access_token>" -H "Content-Type: application/json" -k "<base_url>/api/v1/lookups/<lookup_name>" --output <file_name>Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<lookup_name>is the name of the lookup value, in alphanumeric format<file_name>is the file name (for example,<output>.json)
An example of the output is as follows:
"LookupCodes": [
{
"lov_name": "Document Sub Type",
"lov_values": [
{
"lov_code": "NATIONAL_ID",
"display_value": "Identity card number",
"active": "True"
},
{
"lov_code": "PASSPORT",
"display_value": "Passport number",
"active": "True"
}
]
},
{
"lov_name": "Document Type",
"lov_values": [
{
"lov_code": "NUMERO_PASSEPORT/CARTE_D'IDENT",
"display_value": "Passport_Number/ID_Card",
"active": "True"
}
]
}Task 9: Get patient group data
Issue the following cURL command:
curl -X GET -H "Authorization: Bearer <app_access_token>" -H "Content-Type: application/json" -k "<base_url>/api/v1/groups/<group_name>" --output <file_name>Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<group_name>is the name of the group value, in alphanumeric format<file_name>is the file name (for example,<output>.json)
An example of the output is as follows:
{
"groups": [
{
"code": "1616ASDASD",
"name": "testGroupUploaded",
"description": "Description group uploaded"
}
]
}Task 10: Get product data
Issue the following cURL command:
curl -X GET -H "Authorization: Bearer <app_access_token>" -H "Content-Type: application/json" -k "<base_url>/api/v1/products/<product_name>" --output <file_name>Where:
<app_access_token>is the value obtained from the access token, in alphanumeric format<base_url>is the base URL path for Oracle Health Immunization Management Cloud Service<product_name>is the name of the product value, in alphanumeric format<file_name>is the file name (for example,<output>.json)
An example of the output is as follows:
{
"Products": [
{
"product_name": "BBIBP-CorV",
"product_display_name": "BBIBP-CorV (SINOPHARM)",
"product_category_lv_code": "VACCINE",
"product_category_display_value": "Vaccin",
"dose_number": null,
"cvx": "510",
"administered_route_lv_code": "IMR",
"administered_route_display_value": "Voie intramusculaire",
"manufacturer_name": "SINOPHARM",
"mvx": "SIN",
"min_days_before_next_dose": null,
"minimum_recommended_age": null,
"maximum_recommended_age": null,
"dose_amount_ml": null,
"constitution_required": "N",
"vaccine_code ": null
}
]
}Task 11: Browse the APIs
The main left-side navigation of the API documentation is organized around tasks. If you prefer to browse the API endpoints in a different order:
- Select All REST Endpoints under Introduction.
- Choose one of the Sort by options at the top of the page.