Prime Data Ingestion API v1
The Prime Data Ingestion (PDI) service enables uploading, normalizing, and standardizing clinical data from a variety of data source types for use in the Longitudinal Record service and other HealtheIntent services. The PDI service is intended to be used by data contributors who can transform their data into PDI’s supported record types (for example, Condition and Observation). Currently, the PDI service supports only JSON-formatted record types. Each data record that is uploaded using the PDI API must be uniquely identifiable.
URL: https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1
Record Types
Record types are the types of records that can be contributed, or uploaded, to the HealtheIntent platform using the PDI API. The record types for the PDI service closely align with the various data models supported by the HealtheIntent platform. The supported record types (for example, Patient, Observation, Condition, and PatientDocumentReference) are determined by the PDI service.
Retrieve a List of Record Types
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "PATIENT_DOCUMENT_REFERENCE",
"name": "Patient Document Reference"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types?offset=0&limit=20"
}
GET /record-types
Retrieves the list of supported record types.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The list of record types. | RecordTypes |
| 400 | Bad Request | Bad Request | BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
Retrieve a Single Record Type
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types/PATIENT_DOCUMENT_REFERENCE', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types/PATIENT_DOCUMENT_REFERENCE \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "PATIENT_DOCUMENT_REFERENCE",
"name": "Patient Document Reference"
}
GET /record-types/{recordTypeId}
Retrieves a specific record type by ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| recordTypeId | path | string | true | N/A | The unique ID of the record type. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The record type. | RecordType |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Record Type Schemas
Each record type has one to many schemas, which allows schemas to evolve. All contributed records are checked for conformance to a specific record type schema. The supported schemas are determined by the PDI service.
Retrieve a List of Record Type Schemas
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types/PATIENT_DOCUMENT_REFERENCE/schemas', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types/PATIENT_DOCUMENT_REFERENCE/schemas \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "1.0"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types-schemas/PATIENT_DOCUMENT_REFERENCE/schemas?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types-schemas/PATIENT_DOCUMENT_REFERENCE/schemas?offset=0&limit=20"
}
GET /record-types/{recordTypeId}/schemas
Retrieves the collection of schemas for a specific record type.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| recordTypeId | path | string | true | N/A | The unique ID of the record type. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The collection of schemas. | RecordTypeSchemaItems |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Retrieve a Single Record Type Schema
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types/PATIENT_DOCUMENT_REFERENCE/schemas/1.0', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/record-types/PATIENT_DOCUMENT_REFERENCE/schemas/1.0 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "1.0",
"schema": "<Base64-Encoded String>"
}
GET /record-types/{recordTypeId}/schemas/{schemaId}
Retrieves a specific record type schema instance.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| schemaId | path | string | true | N/A | The ID of a specific schema of a record type. | - |
| recordTypeId | path | string | true | N/A | The unique ID of the record type. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The schema instance. | RecordTypeSchema |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Data Sources
Contributed records originate from data sources. Each data source is owned by the tenant who creates it, which means that the tenant owns all the data contributed from it.
Retrieve a List of Prime Data Sources
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "f3bc39e9-3efc-4709-95f3-5c153fa8bec4"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources?offset=0&limit=20"
}
GET /data-sources
Retrieves a list of all the data sources that are owned by the tenant and can contribute data records using the PDI service.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The list of data sources. | DataSources |
| 400 | Bad Request | Bad Request | BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
Retrieve a Single Prime Data Source
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "f3bc39e9-3efc-4709-95f3-5c153fa8bec4"
}
GET /data-sources/{dataSourceId}
Retrieves a single data source that is owned by the tenant and registered with the PDI service.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The specified data source. | DataSource |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Register a Prime Data Source
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
PUT /data-sources/{dataSourceId}
Registers the tenant-owned data source with the PDI service. The data source must already exist in the Data Source service.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No Content. | None |
| 400 | Bad Request | Bad Request | BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
Record Sets
A record set categorizes and organizes contributed records within a data source. For example, the data source may want to organize their contributed vital measurements and lab results records separately using record sets, even though they both utilize the Observation record type. Each record set must indicate the record type (only one) that will be used to validate the structure of the contributed records.
Add a Record Set
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST /data-sources/{dataSourceId}/record-sets
Adds a record set to a data source.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
| body | body | postDataSourcesDatasourceidRecordSets | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No Content | None |
| 400 | Bad Request | Bad Request | BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
| 409 | Conflict | Conflict | ConflictError |
Retrieve a List of Record Sets
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "VITAL_MEASUREMENTS",
"name": "Vital Measurements",
"recordTypeId": "OBSERVATION"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets?offset=0&limit=20"
}
GET /data-sources/{dataSourceId}/record-sets
Retrieves a list of the defined record sets for a specific data source.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The collection of record sets. | RecordSets |
| 400 | Bad Request | Bad Request | BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Updates the name of a record set.
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.patch('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
PATCH /data-sources/{dataSourceId}/record-sets/{recordSetId}
Updates the name of a specific record set.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
| recordSetId | path | string | true | N/A | The ID of the record set, provided by the data contributor, that uniquely identifies the record set within a data source. The record set ID may only contain alphanumeric characters, underscores, or dashes. | - |
| body | body | patchDataSourcesDatasourceidRecordSets | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No Content. | None |
| 400 | Bad Request | Bad Request | BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Retrieve a single Record Set
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "VITAL_MEASUREMENTS",
"name": "Vital Measurements",
"recordTypeId": "OBSERVATION"
}
GET /data-sources/{dataSourceId}/record-sets/{recordSetId}
Retrieves a specific record set.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
| recordSetId | path | string | true | N/A | The ID of the record set, provided by the data contributor, that uniquely identifies the record set within a data source. The record set ID may only contain alphanumeric characters, underscores, or dashes. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The record set for the specified dataSourceId and recordSetId is retrieved. | RecordSet |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
Contributed Records
Contributed records are records that are sent, or uploaded, to the platform. Each contributed record must be identified by a data source, record set, record type (which is implied by the record set), and record type schema.
Upload Records
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS/schemas/1.0/contributed-records', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS/schemas/1.0/contributed-records \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
POST /data-sources/{dataSourceId}/record-sets/{recordSetId}/schemas/{schemaId}/contributed-records
Uploads, or contributes, records for the specified data source and record set. Each contributed record must adhere to the specified record type schema, which must be a schema for the record type configured for the record set. For example, a Diagnoses record set would likely be configured to use the Condition record type, and therefore the record schema must be one of the Condition schemas. The request body is a JSON array in which each element is a Base64-encoded record that conforms to the associated record type schema.
Body Example:
{
“records”:
[
{ “value”: “
{ “value”: “
]
}
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
| recordSetId | path | string | true | N/A | The ID of the record set, provided by the data contributor, that uniquely identifies the record set within a data source. The record set ID may only contain alphanumeric characters, underscores, or dashes. | - |
| schemaId | path | string | true | N/A | The ID of a specific schema of a record type. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No Content. | None |
| 400 | Bad Request | Bad Request. The following reasons are possible: - failedRecordValidation: A record does not adhere to the provided record type schema. - invalidRecordJson: The JSON containing the encoded records is malformed or could not be read. |
BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
| 413 | Payload Too Large | Payload Too Large | PayloadTooLargeError |
Upload a Record With an Attachment
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS/schemas/1.0/contributed-records-with-attachments', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/prime-data-ingestion/v1/data-sources/f3bc39e9-3efc-4709-95f3-5c153fa8bec4/record-sets/VITAL_MEASUREMENTS/schemas/1.0/contributed-records-with-attachments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
POST /data-sources/{dataSourceId}/record-sets/{recordSetId}/schemas/{schemaId}/contributed-records-with-attachments
Uploads a record for the specified data source and record set with content attachments. This resource uses a multipart/related request to upload the contributed record (for example, a Document Reference record) plus one to many attachments (for example, .PDF documents, .RTF documents, or .JPEG images). The contributed record must be included in the first part of the multipart request body and adhere to the specified record type schema.The schema must be a schema for the record type configured for the record set. For example, a Lab Micro Reports record set would likely be configured to use the Patient Document Reference record type, and therefore the record schema must be one of the Patient Document Reference schemas. The additional parts in the request would contain the content referenced by the attachments in the contributed record. See the RTF 2387 page on the Internet Engineering Task Force (IETF) website for more information about the multipart/related request.
Body Example:
Content-Type: multipart/related; boundary=287032381131322
–287032381131322
Content-Type: application/json; charset=UTF-8
{
“value”:“
}
–287032381131322
Content-Type: application/pdf
[binary data]
–287032381131322
Content-Type: application/pdf
[binary data]
…
–287032381131322–
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| dataSourceId | path | string | true | N/A | The ID of the data source. | - |
| recordSetId | path | string | true | N/A | The ID of the record set, provided by the data contributor, that uniquely identifies the record set within a data source. The record set ID may only contain alphanumeric characters, underscores, or dashes. | - |
| schemaId | path | string | true | N/A | The ID of a specific schema of a record type. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No Content. | None |
| 400 | Bad Request | Bad Request. The following reasons are possible: - failedRecordValidation: A record does not adhere to the provided record type schema. - invalidRecordJson: The JSON containing the encoded records is malformed or could not be read. - missingMimePart: The request does not contain exactly one record and at least one binary attachment. - invalidMimePart: The request is not a well-formed multipart/related request. The error message should have details on how the request is malformed. |
BadRequestError |
| 401 | Unauthorized | Unauthorized | UnauthorizedError |
| 403 | Forbidden | Forbidden | ForbiddenError |
| 404 | Not Found | Not Found | NotFoundError |
| 413 | Payload Too Large | Payload Too Large | PayloadTooLargeError |
Schema Definitions
RecordTypes
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [RecordType] | true | An array containing the current page of results. | - |
| totalResults | integer(int32) | false | The total number of results for the specified parameters. | - |
| firstLink | string | true | The first page of results. | - |
| lastLink | string | false | The last page of results. | - |
| prevLink | string | false | The previous page of results. | - |
| nextLink | string | false | The next page of results. | - |
RecordType
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the record type. | - |
| name | string | true | The human-readable name of the record type. | - |
UnauthorizedError
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | integer(int32) | true | The HTTP response status code that represents the error. | - |
| message | string | true | A human-readable description of the error. | - |
| errorDetails | [UnauthorizedErrorErrorDetail] | false | A list of additional error details. | - |
UnauthorizedErrorErrorDetail
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| domain | string | false | A subsystem or context where an error occurred. | - |
| reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
| message | string | false | A human-readable description of an error. | - |
| locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
| location | string | false | The name of the field that caused an error. | - |
ForbiddenError
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | integer(int32) | true | The HTTP response status code that represents the error. | - |
| message | string | true | A human-readable description of the error. | - |
| errorDetails | [ForbiddenErrorDetail] | false | A list of additional error details. | - |
ForbiddenErrorDetail
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| domain | string | false | A subsystem or context where an error occurred. | - |
| reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
| message | string | false | A human-readable description of an error. | - |
| locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
| location | string | false | The name of the field that caused an error. | - |
BadRequestError
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | integer(int32) | true | The HTTP response status code that represents the error. | - |
| message | string | true | A human-readable description of the error. | - |
| errorDetails | [BadRequestErrorDetail] | false | A list of additional error details. | - |
BadRequestErrorDetail
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| domain | string | false | A subsystem or context where an error occurred. | - |
| reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
| message | string | false | A human-readable description of an error. | - |
| locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
| location | string | false | The name of the field that caused an error. | - |
NotFoundError
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | integer(int32) | true | The HTTP response status code that represents the error. | - |
| message | string | true | A human-readable description of the error. | - |
| errorDetails | [NotFoundErrorDetail] | false | A list of additional error details. | - |
NotFoundErrorDetail
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| domain | string | false | A subsystem or context where an error occurred. | - |
| reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
| message | string | false | A human-readable description of an error. | - |
| locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
| location | string | false | The name of the field that caused an error. | - |
RecordTypeSchemaItems
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [RecordTypeSchemaItem] | true | An array containing the current page of results. | - |
| totalResults | integer(int32) | false | The total number of results for the specified parameters. | - |
| firstLink | string | true | The first page of results. | - |
| lastLink | string | false | The last page of results. | - |
| prevLink | string | false | The previous page of results. | - |
| nextLink | string | false | The next page of results. | - |
RecordTypeSchemaItem
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of a specific schema of a record type. | - |
RecordTypeSchema
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of a specific schema of a record type. | - |
| schema | string | true | A Base64-encoded JSON schema to which records of this type must adhere. | - |
DataSources
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [DataSource] | true | An array containing the current page of results. | - |
| totalResults | integer(int32) | false | The total number of results for the specified parameters. | - |
| firstLink | string | true | The first page of results. | - |
| lastLink | string | false | The last page of results. | - |
| prevLink | string | false | The previous page of results. | - |
| nextLink | string | false | The next page of results. | - |
DataSource
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the data source. | - |
postDataSourcesDatasourceidRecordSets
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the record set, provided by the data contributor, that uniquely identifies the record set within a data source. The record set ID may only contain alphanumeric characters, underscores, or dashes. | - |
| name | string | true | The displayable name of the record set. | - |
| recordTypeId | string | true | The recordTypeId attribute of the type of record that the record set contains. A record set can contain only a single record type. | - |
ConflictError
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | integer(int32) | true | The HTTP response status code that represents the error. | - |
| message | string | true | A human-readable description of the error. | - |
| errorDetails | [ConflictErrorDetail] | false | A list of additional error details. | - |
ConflictErrorDetail
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| domain | string | false | A subsystem or context where an error occurred. | - |
| reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
| message | string | false | A human-readable description of an error. | - |
| locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
| location | string | false | The name of the field that caused an error. | - |
RecordSets
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [RecordSet] | true | An array containing the current page of results. | - |
| totalResults | integer(int32) | false | The total number of results for the specified parameters. | - |
| firstLink | string | true | The first page of results. | - |
| lastLink | string | false | The last page of results. | - |
| prevLink | string | false | The previous page of results. | - |
| nextLink | string | false | The next page of results. | - |
RecordSet
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the record set, provided by the data contributor, that uniquely identifies the record set within a data source. The record set ID may only contain alphanumeric characters, underscores, or dashes. | - |
| name | string | true | The displayable name of the record set. | - |
| recordTypeId | string | true | The recordTypeId attribute of the type of record that the record set contains. A record set can contain only a single record type. | - |
patchDataSourcesDatasourceidRecordSets
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The displayable name of the record set. | - |
PayloadTooLargeError
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | integer(int32) | true | The HTTP response status code that represents the error. | - |
| message | string | true | A human-readable description of the error. | - |
| errorDetails | [PayloadTooLargeErrorErrorDetail] | false | A list of additional error details. | - |
PayloadTooLargeErrorErrorDetail
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| domain | string | false | A subsystem or context where an error occurred. | - |
| reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
| message | string | false | A human-readable description of an error. | - |
| locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
| location | string | false | The name of the field that caused an error. | - |