...
Code Block |
---|
{
"domain" : "Food Insecurity",
"interventionType" : "Provision",
"intervention" : "Provision of food",
"notes" : "",
"agencyName": "Food Pantry",
"dateTimeofIntervention" : "2/4/2020 10:26:00 AM"
}
|
...
Data Element | Description | Required | ||
---|---|---|---|---|
Query String | ||||
| This will be the referral id that was created when the referral was submitted to CIE hub and that was shared with the service organization when the referral was forwarded to them. |
| ||
Body | ||||
| The SDOH Domain associated with the intervention. This is a code based on the gravity project. The following are valid values:
|
| ||
| The type of intervention. This is a code based on the gravity project. The following are examples:
The complete list can be found here Intervention Types and Descriptions
|
| ||
| The intervention that was provided to the patient. The following is a example:
The complete list can be found here Intervention Types and Descriptions |
| ||
| Pass any notes that need to be communicated back to the CIE hub or the referring entity. |
| ||
| The date and time of the intervention. The valid format accepted is MM/DD/YYYY HH:MM:SS [AM/PM] |
| ||
| The name of the agency that is providing the service for the referral. |
Response
The following will be the response values from the calling of the API. The error responses will conform ]to the following specification. https://tools.ietf.org/html/rfc7807 . Please note that all responses will also include a instance value which will uniquely identify the specific request that was made. This ensures uniqueness even if the patient was referred to the CIE multiple times.
...
Code Block |
---|
curl -v --request POST 'https://hub-dev.semi-cie.org/v1/referrals/{id}/interventions' --header 'x-api-key: aGZoczo4****2ZDk=' --header 'Content-Type: application/json' --header 'Authorization: bearer etty****iquerui' --data-raw '{ "domain" : "Food Insecurity", "interventionType" : "Provision", "intervention" : "Provision of food", "notes" : "", "agencyName": "Food Pantry", "dateTimeofIntervention" : "2/4/2020 10:26:00 AM" }' |
...