Contribute document to HIE
curl --request POST \
--url https://api.example.com/api/v2/hie/documents/upload \
--header 'Content-Type: application/json' \
--data '
{
"patientId": "<string>",
"fileMetadataId": "<string>",
"documentType": {
"text": "<string>",
"coding": [
{
"code": "<string>",
"system": "<string>",
"display": "<string>"
}
]
},
"description": "<string>",
"facilityName": "<string>",
"dateStart": "<string>",
"dateEnd": "<string>"
}
'import requests
url = "https://api.example.com/api/v2/hie/documents/upload"
payload = {
"patientId": "<string>",
"fileMetadataId": "<string>",
"documentType": {
"text": "<string>",
"coding": [
{
"code": "<string>",
"system": "<string>",
"display": "<string>"
}
]
},
"description": "<string>",
"facilityName": "<string>",
"dateStart": "<string>",
"dateEnd": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
fileMetadataId: '<string>',
documentType: {
text: '<string>',
coding: [{code: '<string>', system: '<string>', display: '<string>'}]
},
description: '<string>',
facilityName: '<string>',
dateStart: '<string>',
dateEnd: '<string>'
})
};
fetch('https://api.example.com/api/v2/hie/documents/upload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/hie/documents/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patientId' => '<string>',
'fileMetadataId' => '<string>',
'documentType' => [
'text' => '<string>',
'coding' => [
[
'code' => '<string>',
'system' => '<string>',
'display' => '<string>'
]
]
],
'description' => '<string>',
'facilityName' => '<string>',
'dateStart' => '<string>',
'dateEnd' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/hie/documents/upload"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"fileMetadataId\": \"<string>\",\n \"documentType\": {\n \"text\": \"<string>\",\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"system\": \"<string>\",\n \"display\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"facilityName\": \"<string>\",\n \"dateStart\": \"<string>\",\n \"dateEnd\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/hie/documents/upload")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"fileMetadataId\": \"<string>\",\n \"documentType\": {\n \"text\": \"<string>\",\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"system\": \"<string>\",\n \"display\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"facilityName\": \"<string>\",\n \"dateStart\": \"<string>\",\n \"dateEnd\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/hie/documents/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"fileMetadataId\": \"<string>\",\n \"documentType\": {\n \"text\": \"<string>\",\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"system\": \"<string>\",\n \"display\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"facilityName\": \"<string>\",\n \"dateStart\": \"<string>\",\n \"dateEnd\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}HIE
Contribute document to HIE
Contributes a document to the HIE network for a specific patient.
POST
/
api
/
v2
/
hie
/
documents
/
upload
Contribute document to HIE
curl --request POST \
--url https://api.example.com/api/v2/hie/documents/upload \
--header 'Content-Type: application/json' \
--data '
{
"patientId": "<string>",
"fileMetadataId": "<string>",
"documentType": {
"text": "<string>",
"coding": [
{
"code": "<string>",
"system": "<string>",
"display": "<string>"
}
]
},
"description": "<string>",
"facilityName": "<string>",
"dateStart": "<string>",
"dateEnd": "<string>"
}
'import requests
url = "https://api.example.com/api/v2/hie/documents/upload"
payload = {
"patientId": "<string>",
"fileMetadataId": "<string>",
"documentType": {
"text": "<string>",
"coding": [
{
"code": "<string>",
"system": "<string>",
"display": "<string>"
}
]
},
"description": "<string>",
"facilityName": "<string>",
"dateStart": "<string>",
"dateEnd": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
patientId: '<string>',
fileMetadataId: '<string>',
documentType: {
text: '<string>',
coding: [{code: '<string>', system: '<string>', display: '<string>'}]
},
description: '<string>',
facilityName: '<string>',
dateStart: '<string>',
dateEnd: '<string>'
})
};
fetch('https://api.example.com/api/v2/hie/documents/upload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/hie/documents/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'patientId' => '<string>',
'fileMetadataId' => '<string>',
'documentType' => [
'text' => '<string>',
'coding' => [
[
'code' => '<string>',
'system' => '<string>',
'display' => '<string>'
]
]
],
'description' => '<string>',
'facilityName' => '<string>',
'dateStart' => '<string>',
'dateEnd' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/hie/documents/upload"
payload := strings.NewReader("{\n \"patientId\": \"<string>\",\n \"fileMetadataId\": \"<string>\",\n \"documentType\": {\n \"text\": \"<string>\",\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"system\": \"<string>\",\n \"display\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"facilityName\": \"<string>\",\n \"dateStart\": \"<string>\",\n \"dateEnd\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/hie/documents/upload")
.header("Content-Type", "application/json")
.body("{\n \"patientId\": \"<string>\",\n \"fileMetadataId\": \"<string>\",\n \"documentType\": {\n \"text\": \"<string>\",\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"system\": \"<string>\",\n \"display\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"facilityName\": \"<string>\",\n \"dateStart\": \"<string>\",\n \"dateEnd\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/hie/documents/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"patientId\": \"<string>\",\n \"fileMetadataId\": \"<string>\",\n \"documentType\": {\n \"text\": \"<string>\",\n \"coding\": [\n {\n \"code\": \"<string>\",\n \"system\": \"<string>\",\n \"display\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"facilityName\": \"<string>\",\n \"dateStart\": \"<string>\",\n \"dateEnd\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}Body
application/json
The external Patient ID that you store and can use to reference this Patient.
The ID of the file metadata to upload.
The type of document being uploaded.
Show child attributes
Show child attributes
A brief description of the document.
The name and type of facility (e.g., 'John Snow Clinic - Acute Care Centre').
ISO 8601 timestamp for when the document period starts.
ISO 8601 timestamp for when the document period ends.
Response
200 - application/json
Default Response
The response is of type object.
⌘I