...
The following will be the request object that will be sent in the body of the post. The information in the request will represent the information that will be needed to create the intervention person in the CIE Hub. Note that the referral ID passed as a parameter in the URL as documented in the REST URL section above eliminates the need to pass a patient identifier or referral ID in the request object itself.
JSON Example of Request
| Code Block |
|---|
{
"resourceType": "Person",
"identifier": [
{
"use": "usual",
"label": "MRN",
"system": "urn:oid:1.2.36.146.595.217.0.1",
"value": "12345",
"period": {
"start": "2001-05-06"
},
"assigner": {
"display": "Acme Healthcare"
}
}
],
"name": [
{
"use": "official",
"family": [
"Chalmers"
],
"given": [
"Peter",
"James"
]
},
{
"use": "usual",
"given": [
"Jim"
]
}
],
"telecom": [
{
"use": "home"
},
{
"system": "phone",
"value": "(03) 5555 6473",
"use": "work"
}
],
"gender": "male",
"birthDate": "1974-12-25",
"address": [
{
"use": "home",
"line": [
"534 Erewhon St"
],
"city": "PleasantVille",
"state": "Vic",
"postalCode": "3999"
}
],
"active": true
}
|
...
Data Element | Description | Required | |||
|---|---|---|---|---|---|
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 ISO String. Here is a link to the format https://www.w3.org/TR/NOTE-datetime
|
| ||
| 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.
...