# Awell Workflow URL: https://docs.awellhealth.com/docs/marketplace/awell > For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt). Enrich your care flows with powerful Awell actions. Category: Workflow. Adds 17 actions and 2 webhooks to a care flow. ## Actions [#actions] Awell Workflow adds these 17 actions to a care flow. Add one to a step, then fill in its inputs. ### Add ad hoc track [#add-ad-hoc-track] Add a pre-configured ad hoc track to a patient care flow. This action retries automatically on a transient failure. | Input | Type | Required | Description | | -------- | -------- | -------- | ------------------------------------------------------------------------- | | Track ID | `string` | Yes | The ID of the ad hoc track that you want to add to the patient care flow. | ### Add identifier to patient [#add-identifier-to-patient] Add a new identifier to the patient's profile This action retries automatically on a transient failure. | Input | Type | Required | Description | | ---------------- | -------- | -------- | -------------------------------------- | | System | `string` | Yes | The namespace for the identifier value | | Identifier value | `string` | Yes | The value of the identifier | This action allows you to add a unique identifier to the current patient's profile. If the patient already has an identifier with the same system but a different value, this action will update the existing identifier with the new value provided. First, it checks if this identifier (system and value) is already associated with another patient. If it's safe to proceed, it will add or update the identifier as needed. However, if another patient already has this identifier, the action will stop and notify you, preventing duplicates. To avoid conflicts, we recommend first running the "Get patient by identifier" action to check for any existing matches. ### Create Navi Session [#create-navi-session] Create a Navi portal session for a stakeholder This action retries automatically on a transient failure. | Input | Type | Required | Description | | -------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------- | | Stakeholder | `string` | No | The stakeholder to create the session for. Leave empty to default to the patient. | | Expiration (epoch seconds) | `string` | No | When the session should expire, as a Unix timestamp in seconds. If left empty, we default to 30 days. | Returns: | Data point | Type | | ---------------- | -------- | | `naviSessionUrl` | `string` | | `sessionId` | `string` | | `statusCode` | `string` | ### Get current care flow ID [#get-current-care-flow-id] Get the current care flow ID This action retries automatically on a transient failure. No inputs — this action takes no configuration. Returns: | Data point | Type | | ---------------------- | -------- | | `careFlowDefinitionId` | `string` | | `careFlowId` | `string` | ### Get data point value [#get-data-point-value] Get the value of a data point This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------------------ | -------- | -------- | -------------------------------------------------------------------------------------------------- | | Care flow ID | `string` | Yes | The care flow to get the data point value from. Can be a different care flow than the current one. | | Data point definition ID | `string` | Yes | The data point definition ID to get the value from. | Returns: | Data point | Type | | ------------------- | --------------- | | `valueBoolean` | `boolean` | | `valueDate` | `date` | | `valueJson` | `json` | | `valueNumber` | `number` | | `valueString` | `string` | | `valueStringsArray` | `strings_array` | | `valueStringsArray` | `strings_array` | | `valueTelephone` | `telephone` | This action allows you to read the most recent data point value of a given data point definition id from a care flow different from the current one. The action returns multiple data points, each with a different value type. Pick the one you need from the returned data points based on the value type of the data point you want to read the value from. **Example**: If the data point you want to read the value from is of type `number`, then you should use the `valueNumber` data point. ### Get patient by identifier [#get-patient-by-identifier] Retrieve a patient based on the provided identifier system and value This action can be previewed in Studio before you publish, and retries automatically on a transient failure. | Input | Type | Required | Description | | ---------------- | -------- | -------- | -------------------------------------- | | System | `string` | Yes | The namespace for the identifier value | | Identifier value | `string` | Yes | The value of the identifier | Returns: | Data point | Type | | ---------------------- | --------- | | `patientAlreadyExists` | `boolean` | | `patientId` | `string` | This action lets you check if a patient with a specific identifier already exists in Awell. It's particularly useful when a patient's identity is initially anonymous during the start of the care flow, but later becomes identifiable through the identifiers collected during the care flow. This check ensures whether a patient with that identifier is already present or not. ### Is patient already enrolled in care flow [#is-patient-already-enrolled-in-care-flow] Checks whether the patient is already enrolled in the current care flow definition. This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------------------ | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Pathway status | `string` | No | A comma-separated string of care flow statuses that will be used when looking for care flows the patient is already enrolled in. By default, we only look at active care flows. Possible values are: starting, active, stopped, completed, missing\_baseline\_info. | | Care flow definition IDs | `string` | No | A comma-separated string of care flow definition ids that will be used when looking for care flows the patient is already enrolled in. By default, we only search for care flows that match the current care flow definition id (i.e. is the patient already included in the current care flow?). | | Past day range | `numeric` | No | The number of days to look back for care flows that were started in the past, e.g last 30 days. | Returns: | Data point | Type | | -------------- | --------- | | `careFlowIds` | `string` | | `nbrOfResults` | `number` | | `result` | `boolean` | Checks whether the patient is already enrolled in a care flow definition. The care flow the patient is currently enrolled in does not count and is excluded from the results. \*\*Action fields: * pathwayStatus: a comma-separated string of care flow statuses that will be used when looking for care flows the patient is already enrolled in. By default, we only look at active care flows. Options: "active", "completed", "missing\_baseline\_info", "starting", and "stopped". * careFlowDefinitionIds: a comma-separated string of care flow definition ids that will be used when looking for care flows the patient is already enrolled in. By default, we only search for care flows that match the current care flow definition id (i.e. is the patient already included in the current care flow?). Data points\*\*: * result: a boolean indicating whether the patient is already enrolled in another care flow that matches your criteria (status & care flow definition id) * nbrOfResults: the number of care flows found for the patient that match the criteria. * careFlowIds: a comma-separated string of care flow ids that matched your search criteria. It will be empty when the result is `false` because then there are no other care flow ids that match your criteria. ### Check patient track enrollment status [#check-patient-track-enrollment-status] Checks whether the patient is enrolled, has been enrolled, or is scheduled to be enrolled in a specific track. This is time-based and will return the status of the track at the time of the check. This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------------- | -------- | -------- | -------------------------------------------------------------- | | Track definition ID | `string` | Yes | The definition ID of the track to check enrollment status for. | Returns: | Data point | Type | | ---------------------------- | --------- | | `has_been_enrolled_in_track` | `boolean` | | `is_enrolled_in_track` | `boolean` | | `next_track_scheduled_date` | `date` | | `track_is_scheduled` | `boolean` | ### List form answers [#list-form-answers] List form answers This action retries automatically on a transient failure. | Input | Type | Required | Description | | ----------------------- | --------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Scope | `string` | No | The scope in which to look for forms. Default is "Step" (current step only). One of: Step, Track. | | Form selection | `string` | No | Whether to capture the most recent form or all forms in the scope. Default is "Latest". Form headers will be included if "All" is selected. One of: Latest, All. | | Language | `string` | No | The language the output should be in. Default is English. One of: English, Dutch, French. | | Include descriptions | `boolean` | No | Should descriptions be included in the output? Default is "Yes". | | Include missing answers | `boolean` | No | Should missing or unanswered questions be included in the output? Default is "Yes". | | Separator | `string` | No | The separator to use between questions. If not provided, questions will be separated by a blank line. | Returns: | Data point | Type | | ----------------------- | -------- | | `numberOfFormsCaptured` | `number` | | `output` | `string` | ### Search patient by patient code (DEPRECATED, USE IDENTIFIERS) [#search-patient-by-patient-code-deprecated-use-identifiers] Search whether the current patient already exists. Search happens based on the `patient_code` field which is taken from the patient's profile. This action can be previewed in Studio before you publish, and retries automatically on a transient failure. No inputs — this action takes no configuration. Returns: | Data point | Type | | ----------------------- | --------- | | `awellPatientIds` | `string` | | `numberOfPatientsFound` | `number` | | `patientAlreadyExists` | `boolean` | Note that this action is deprecated and we recommend using [identifiers](https://developers.awellhealth.com/awell-orchestration/docs/misc/patient-identifiers) instead. Search whether, apart from the patient currently enrolled in the care flow, another patient with the same `patient_code` already exists. **Data points**: 1. patientAlreadyExists: a boolean which will be true if minimum one patient with the patient code already exists. 2. numberOfPatientsFound: the number of patients found with the same patient code. 3. awellPatientIds: a comma-separated string of all Awell patient ids (except the current patient) that have the same patient code as the patient currently enrolled in the care flow. Will return an empty string when there are no other patients with the same patient code. ### Start care flow [#start-care-flow] Start a new care flow for the patient currently enrolled in the care flow. This action retries automatically on a transient failure. | Input | Type | Required | Description | | ----------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Care flow definition ID | `string` | Yes | The identifier of the care flow definition to start. | | Baseline info | `json` | No | Use baseline info to pass values for data points when starting a care flow. This needs to be an array of objects, please read the documentation for more info. | Returns: | Data point | Type | | ------------ | -------- | | `careFlowId` | `string` | Starts a new care flow for the patient enrolled in your current care flow. \*\*Passing baseline info: Please read the documentation on [our developer hub](https://developers.awellhealth.com/awell-orchestration/api-reference/mutations/start-pathway) to learn more about how to pass baseline info. Example of how to configure a value for the baseline info action field\*\*: ```json [ { "data_point_definition_id": "age", "value": "29" }, { "data_point_definition_id": "dob", "value": "1993-11-30" } ] ``` ### Start Care flow and session [#start-care-flow-and-session] Start a new care flow and immediately create a session This action retries automatically on a transient failure. | Input | Type | Required | Description | | ----------------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Care flow definition ID | `string` | Yes | The definition ID of the care flow to start | | Stakeholder | `string` | Yes | The stakeholder to start the session for One of: Physician, Patient. | | Baseline info | `json` | No | Use baseline info to pass values for data points when starting a care flow. This needs to be an array of objects, please read the documentation for more info. | Returns: | Data point | Type | | ------------ | -------- | | `careFlowId` | `string` | | `sessionUrl` | `string` | ### Start Hosted Pages Session [#start-hosted-pages-session] Start a new Hosted Pages session for a given stakeholder This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------ | -------- | -------- | ------------------------------------------------------- | | Care flow ID | `string` | Yes | The instance ID of the care flow to start a session for | | Stakeholder | `string` | Yes | The name of the stakeholder to start the session for | Returns: | Data point | Type | | ------------ | -------- | | `sessionUrl` | `string` | ### Stop care flow [#stop-care-flow] Stop the care flow the patient is currently enrolled. This action retries automatically on a transient failure. | Input | Type | Required | Description | | --------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Care flow ID(s) | `string` | No | The care flow ID(s) to stop. You can stop multiple care flows at once by separating the IDs with a comma. If not provided, the current care flow will be stopped. | | Reason | `string` | Yes | The reason why you want to stop the care flow. | Stops the care flow the patient is currently enrolled in. A reason is why you are stopping the care flow is mandatory. ### Stop track [#stop-track] Stop a track in a patient care flow (pathway). This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------------- | -------- | -------- | ---------------------------------------------------- | | Track definition ID | `string` | Yes | The definitionID of the track that you want to stop. | ### Update Baseline Datapoints [#update-baseline-datapoints] Update some (or all) of the baseline datapoints for the patient currently enrolled in the care flow. This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------- | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Care flow ID | `string` | No | The ID of the care flow to update the baseline info for. When not provided, the baseline info will be updated for the current care flow. | | Baseline info | `json` | No | Use baseline data points often used to start a care flow. Example: \[ \{ "data\_point\_definition\_id": "age", "value": "29" }, \{ "data\_point\_definition\_id": "dob", "value": "1993-11-30" } ] | Returns: | Data point | Type | | ---------- | --------- | | `success` | `boolean` | ### Update patient [#update-patient] Update the current patient with new data. This action retries automatically on a transient failure. | Input | Type | Required | Description | | ------------------------ | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Patient code | `string` | No | — | | First name | `string` | No | — | | Last name | `string` | No | — | | Email | `string` | No | — | | Birth date | `date` | No | — | | Mobile phone | `string` | No | — | | Phone | `string` | No | — | | Preferred language | `string` | No | — | | Sex | `string` | No | Sex code as defined by ISO standard IEC\_5218 One of: FEMALE, MALE, NOT\_KNOWN. | | City | `string` | No | — | | Country | `string` | No | — | | State | `string` | No | — | | Street | `string` | No | — | | ZIP | `string` | No | — | | National registry number | `string` | No | — | | Patient timezone | `string` | No | One of: Africa/Algiers, Atlantic/Cape\_Verde, Africa/Ndjamena, Africa/Abidjan, Africa/Cairo, Africa/Bissau, Africa/Nairobi, Africa/Monrovia, Africa/Tripoli, Indian/Mauritius, Africa/Casablanca, Africa/El\_Aaiun, Africa/Maputo, Africa/Windhoek, Africa/Lagos, Africa/Sao\_Tome, Africa/Johannesburg, Africa/Khartoum, Africa/Juba, Africa/Tunis, Antarctica/Casey, Antarctica/Davis, Antarctica/Mawson, Antarctica/Troll, Antarctica/Vostok, Antarctica/Rothera, Asia/Kabul, Asia/Yerevan, Asia/Baku, Asia/Dhaka, Asia/Thimphu, Indian/Chagos, Asia/Yangon, Asia/Shanghai, Asia/Urumqi, Asia/Hong\_Kong, Asia/Taipei, Asia/Macau, Asia/Nicosia, Asia/Famagusta, Asia/Tbilisi, Asia/Dili, Asia/Kolkata, Asia/Jakarta, Asia/Pontianak, Asia/Makassar, Asia/Jayapura, Asia/Tehran, Asia/Baghdad, Asia/Jerusalem, Asia/Tokyo, Asia/Amman, Asia/Almaty, Asia/Qyzylorda, Asia/Qostanay, Asia/Aqtobe, Asia/Aqtau, Asia/Atyrau, Asia/Oral, Asia/Bishkek, Asia/Seoul, Asia/Pyongyang, Asia/Beirut, Asia/Kuching, Indian/Maldives, Asia/Hovd, Asia/Ulaanbaatar, Asia/Kathmandu, Asia/Karachi, Asia/Gaza, Asia/Hebron, Asia/Manila, Asia/Qatar, Asia/Riyadh, Asia/Singapore, Asia/Colombo, Asia/Damascus, Asia/Dushanbe, Asia/Bangkok, Asia/Ashgabat, Asia/Dubai, Asia/Samarkand, Asia/Tashkent, Asia/Ho\_Chi\_Minh, Australia/Darwin, Australia/Perth, Australia/Eucla, Australia/Brisbane, Australia/Lindeman, Australia/Adelaide, Australia/Hobart, Australia/Melbourne, Australia/Sydney, Australia/Broken\_Hill, Australia/Lord\_Howe, Antarctica/Macquarie, Pacific/Fiji, Pacific/Gambier, Pacific/Marquesas, Pacific/Tahiti, Pacific/Guam, Pacific/Tarawa, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kwajalein, Pacific/Kosrae, Pacific/Nauru, Pacific/Noumea, Pacific/Auckland, Pacific/Chatham, Pacific/Rarotonga, Pacific/Niue, Pacific/Norfolk, Pacific/Palau, Pacific/Port\_Moresby, Pacific/Bougainville, Pacific/Pitcairn, Pacific/Pago\_Pago, Pacific/Apia, Pacific/Guadalcanal, Pacific/Fakaofo, Pacific/Tongatapu, Pacific/Efate, Australia/ACT, Australia/LHI, Australia/NSW, Australia/North, Australia/Queensland, Australia/South, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Cuba, EET, EST, EST5EDT, Egypt, Eire, Etc/GMT+0, Etc/GMT-0, Etc/GMT0, Etc/Greenwich, Etc/UCT, Etc/Universal, Etc/Zulu, GB, GB-Eire, GMT+0, GMT-0, GMT0, Greenwich, Hongkong, Iceland, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, Poland, Portugal, ROC, ROK, Singapore, Turkey, UCT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Samoa, UTC, Universal, W-SU, Zulu, America/Buenos\_Aires, America/Catamarca, America/Cordoba, America/Indianapolis, America/Jujuy, America/Knox\_IN, America/Louisville, America/Mendoza, America/Virgin, Pacific/Samoa, Africa/Accra, Africa/Addis\_Ababa, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Conakry, Africa/Dakar, Africa/Dar\_es\_Salaam, Africa/Djibouti, Africa/Douala, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Kampala, Africa/Kigali, Africa/Kinshasa, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, America/Anguilla, America/Antigua, America/Aruba, America/Atikokan, America/Blanc-Sablon, America/Cayman, America/Creston, America/Curacao, America/Dominica, America/Grenada, America/Guadeloupe, America/Kralendijk, America/Lower\_Princes, America/Marigot, America/Montserrat, America/Nassau, America/Port\_of\_Spain, America/St\_Barthelemy, America/St\_Kitts, America/St\_Lucia, America/St\_Thomas, America/St\_Vincent, America/Tortola, Antarctica/DumontDUrville, Antarctica/McMurdo, Antarctica/Syowa, Arctic/Longyearbyen, Asia/Aden, Asia/Bahrain, Asia/Brunei, Asia/Kuala\_Lumpur, Asia/Kuwait, Asia/Muscat, Asia/Phnom\_Penh, Asia/Vientiane, Atlantic/Reykjavik, Atlantic/St\_Helena, Europe/Amsterdam, Europe/Bratislava, Europe/Busingen, Europe/Copenhagen, Europe/Guernsey, Europe/Isle\_of\_Man, Europe/Jersey, Europe/Ljubljana, Europe/Luxembourg, Europe/Mariehamn, Europe/Monaco, Europe/Oslo, Europe/Podgorica, Europe/San\_Marino, Europe/Sarajevo, Europe/Skopje, Europe/Stockholm, Europe/Vaduz, Europe/Vatican, Europe/Zagreb, Indian/Antananarivo, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Mayotte, Indian/Reunion, Pacific/Chuuk, Pacific/Funafuti, Pacific/Majuro, Pacific/Midway, Pacific/Pohnpei, Pacific/Saipan, Pacific/Wake, Pacific/Wallis, Africa/Timbuktu, America/Argentina/ComodRivadavia, America/Atka, America/Coral\_Harbour, America/Ensenada, America/Fort\_Wayne, America/Montreal, America/Nipigon, America/Pangnirtung, America/Porto\_Acre, America/Rainy\_River, America/Rosario, America/Santa\_Isabel, America/Shiprock, America/Thunder\_Bay, America/Yellowknife, Antarctica/South\_Pole, Asia/Choibalsan, Asia/Chongqing, Asia/Harbin, Asia/Kashgar, Asia/Tel\_Aviv, Atlantic/Jan\_Mayen, Australia/Canberra, Australia/Currie, Europe/Belfast, Europe/Tiraspol, Europe/Uzhgorod, Europe/Zaporozhye, Pacific/Enderbury, Pacific/Johnston, Pacific/Yap, WET, Africa/Asmera, America/Godthab, Asia/Ashkhabad, Asia/Calcutta, Asia/Chungking, Asia/Dacca, Asia/Istanbul, Asia/Katmandu, Asia/Macao, Asia/Rangoon, Asia/Saigon, Asia/Thimbu, Asia/Ujung\_Pandang, Asia/Ulan\_Bator, Atlantic/Faeroe, Europe/Kiev, Europe/Nicosia, HST, PST8PDT, Pacific/Ponape, Pacific/Truk, Etc/UTC, Etc/GMT, GMT, Etc/GMT-14, Etc/GMT-13, Etc/GMT-12, Etc/GMT-11, Etc/GMT-10, Etc/GMT-9, Etc/GMT-8, Etc/GMT-7, Etc/GMT-6, Etc/GMT-5, Etc/GMT-4, Etc/GMT-3, Etc/GMT-2, Etc/GMT-1, Etc/GMT+1, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Europe/London, Europe/Dublin, Europe/Tirane, Europe/Andorra, Europe/Vienna, Europe/Minsk, Europe/Brussels, Europe/Sofia, Europe/Prague, Atlantic/Faroe, America/Danmarkshavn, America/Scoresbysund, America/Nuuk, America/Thule, Europe/Tallinn, Europe/Helsinki, Europe/Paris, Europe/Berlin, Europe/Gibraltar, Europe/Athens, Europe/Budapest, Europe/Rome, Europe/Riga, Europe/Vilnius, Europe/Malta, Europe/Chisinau, Europe/Warsaw, Europe/Lisbon, Atlantic/Azores, Atlantic/Madeira, Europe/Bucharest, Europe/Kaliningrad, Europe/Moscow, Europe/Simferopol, Europe/Astrakhan, Europe/Volgograd, Europe/Saratov, Europe/Kirov, Europe/Samara, Europe/Ulyanovsk, Asia/Yekaterinburg, Asia/Omsk, Asia/Barnaul, Asia/Novosibirsk, Asia/Tomsk, Asia/Novokuznetsk, Asia/Krasnoyarsk, Asia/Irkutsk, Asia/Chita, Asia/Yakutsk, Asia/Vladivostok, Asia/Khandyga, Asia/Sakhalin, Asia/Magadan, Asia/Srednekolymsk, Asia/Ust-Nera, Asia/Kamchatka, Asia/Anadyr, Europe/Belgrade, Europe/Madrid, Africa/Ceuta, Atlantic/Canary, Europe/Zurich, Europe/Istanbul, Europe/Kyiv, Factory, America/New\_York, America/Chicago, America/North\_Dakota/Center, America/North\_Dakota/New\_Salem, America/North\_Dakota/Beulah, America/Denver, America/Los\_Angeles, America/Juneau, America/Sitka, America/Metlakatla, America/Yakutat, America/Anchorage, America/Nome, America/Adak, Pacific/Honolulu, America/Phoenix, America/Boise, America/Indiana/Indianapolis, America/Indiana/Marengo, America/Indiana/Vincennes, America/Indiana/Tell\_City, America/Indiana/Petersburg, America/Indiana/Knox, America/Indiana/Winamac, America/Indiana/Vevay, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Detroit, America/Menominee, America/St\_Johns, America/Goose\_Bay, America/Halifax, America/Glace\_Bay, America/Moncton, America/Toronto, America/Winnipeg, America/Regina, America/Swift\_Current, America/Edmonton, America/Vancouver, America/Dawson\_Creek, America/Fort\_Nelson, America/Iqaluit, America/Resolute, America/Rankin\_Inlet, America/Cambridge\_Bay, America/Inuvik, America/Whitehorse, America/Dawson, America/Cancun, America/Merida, America/Matamoros, America/Monterrey, America/Mexico\_City, America/Ciudad\_Juarez, America/Ojinaga, America/Chihuahua, America/Hermosillo, America/Mazatlan, America/Bahia\_Banderas, America/Tijuana, America/Barbados, America/Belize, Atlantic/Bermuda, America/Costa\_Rica, America/Havana, America/Santo\_Domingo, America/El\_Salvador, America/Guatemala, America/Port-au-Prince, America/Tegucigalpa, America/Jamaica, America/Martinique, America/Managua, America/Panama, America/Puerto\_Rico, America/Miquelon, America/Grand\_Turk, America/Argentina/Buenos\_Aires, America/Argentina/Cordoba, America/Argentina/Salta, America/Argentina/Tucuman, America/Argentina/La\_Rioja, America/Argentina/San\_Juan, America/Argentina/Jujuy, America/Argentina/Catamarca, America/Argentina/Mendoza, America/Argentina/San\_Luis, America/Argentina/Rio\_Gallegos, America/Argentina/Ushuaia, America/La\_Paz, America/Noronha, America/Belem, America/Santarem, America/Fortaleza, America/Recife, America/Araguaina, America/Maceio, America/Bahia, America/Sao\_Paulo, America/Campo\_Grande, America/Cuiaba, America/Porto\_Velho, America/Boa\_Vista, America/Manaus, America/Eirunepe, America/Rio\_Branco, America/Santiago, America/Coyhaique, America/Punta\_Arenas, Pacific/Easter, Antarctica/Palmer, America/Bogota, America/Guayaquil, Pacific/Galapagos, Atlantic/Stanley, America/Cayenne, America/Guyana, America/Asuncion, America/Lima, Atlantic/South\_Georgia, America/Paramaribo, America/Montevideo, America/Caracas. | Allows updating patient data for the patient currently enrolled in the care flow. ## Webhooks [#webhooks] Awell Workflow can send these 2 events into Awell, where each one can start a care flow or move a patient along. Point the webhook at the URL Studio shows you when you enable it. ### `pathwayCompleted` [#pathwaycompleted] Payload: | Data point | Type | | ----------------------- | -------- | | `complete_date` | `date` | | `pathway_definition_id` | `string` | ### `pathwayStart` [#pathwaystart] This event carries no payload data points. ## Setup and notes [#setup-and-notes] ### Extension settings [#extension-settings] You will need to provide the [API URL](https://developers.awellhealth.com/awell-orchestration/api-reference/overview/endpoints) and an [API key](https://developers.awellhealth.com/awell-orchestration/api-reference/overview/authorization). ### Webhooks [#webhooks-1] Webhooks in the Awell extension offer ways to trigger a care flow based on the end of another care flow, or from any event that happens in your system (via the pathwayStart webhook). ## Changelog [#changelog] ### April 2024 [#april-2024] Two new action were added: "Get patient by identifier" and "Add identifier to patient". ### October 26, 2023 [#october-26-2023] Generic webhook to start a care flow added ### April 19, 2023 [#april-19-2023] Stop care flow action added. Search patients by patient code action was added. "Is patient enrolled in care flow" action added. ## Where this page comes from [#where-this-page-comes-from] The settings, actions, inputs, outputs and webhooks above are generated from the extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the platform actually does rather than a description of it. Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).