All Collections
Developer Integrations
FHIR Extension: LaunchString
FHIR Extension: LaunchString

Documentation for our LaunchString Extension in FHIR4

Rachel Shelswell avatar
Written by Rachel Shelswell
Updated over a week ago

Description:

The launchString FHIR extension is used by an external application to launch an authenticated page in Caredove that may be pre-populated with information, such as client demographics to be filled in a referral form.

This extension is located under the "process-request" Task resource associated with the ServiceRequest resource.

The extension is included in the following webhook messages from Caredove:

  • notify-add-process-request

  • notify-update-process-request

Also, the extension is included in the RESPONSE to the following messages sent to Caredove.

  • add-service-request

  • cds-service-request

This extension has two parts (as FHIR sub-extensions)

  • LaunchUrl: A link that brings the user to either the first step of a booking process, or a Caredove listings webpage, which has the users information pre-filled while going through Caredove's booking process for a referral.
    Datatype: valueUri

  • validUntil: A timestamp provided by Caredove with the exact time the LaunchUrl will expire.
    Datatype: valuePeriod

Resource & Resource Element Locations:

This extension is located under the "process-request" Task resource associated with the ServiceRequest resource.

Example:

{
"resourceType": "Task",
"id": "123456789",
"...": "...",
"extension": [
{
"url": "http://help.caredove.com/developer-integrations/fhir-extension-launchstring",
"extension": [
{
"url": "launchURL",
"valueUri": "https://sandbox.caredove.com/applaunch?fhirServiceUrl=https%3A%2F%2Fsandbox.caredove.com%2Fapi%2Fnative&patientId=pn8e6mkbgecbpusq0k760l2bn1-5636247958-16770&intent=display-headerbar&need_patient_banner=false"
},
{
"url": "validUntil",
"valuePeriod": {
"end": "2023-01-27T16:34:22+00:00"
}
}
]
}
]
}




Did this answer your question?