Full Payload Schema
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://sv.telesv.com/schemas/CreateExternalCustomData_v1.001.json",
"type": "object",
"title": "CreateExternalCustomData",
"description": "This command is used to send custom data values",
"properties": {
"header": {
"title": "CreateExternalCustomDataHeader",
"allOf": [
{
"$ref": "../models/business-command-initialization-header-v3.001.json"
},
{
"properties": {
"command": {
"const": "CreateExternalCustomData"
}
}
}
]
},
"body": {
"title": "CreateExternalCustomDataBody",
"allOf": [
{
"$ref": "../models/external-custom-data-v1.001.json"
}
]
}
}
}Example Properties JSON
{
"header": {
"id":"b6e2aef4-3dbf-4f49-a3e2-9c5bcf7a6ad7",
"schemaUri":"https://sv.telesv.com/schemas/CreateExternalCustomData_v1.001.json",
"version":"1.001",
"command":"CreateExternalCustomData",
"sourceId":"15a8671a-7716-4d53-9798-6716aff7f9af",
"correlationId":"1f9cbe61-9de3-4ab0-b6e6-81cf7b4c35d8",
"tenantId":"75de8cfd-40af-427a-9279-cae6ea33248e",
"dateTime": "2024-08-07T14:20:00Z",
"userId":"f69489bc-e6d3-42a6-86d8-acf4012f3ee9",
"ttl":100000
},
"body": {
"externalSource": "PWCDIS",
"facilityExternalId": "101",
"visitExternalId": "VN123456",
"locationExternalId": "Room1",
"patientExternalId": "MRN123456",
"externalDataCategory": "PatientAttribute",
"externalDataId": "UD11",
"externalDataValue": "Combative"
}
}Header Schema
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "#business-command-initialization-header-v3.001",
"type": "object",
"title": "BusinessCommandInitializationHeader",
"description": "Header metadata that helps describe an initial command issued from a service",
"properties": {
"schemaUri": { "$ref": "../types/string-required-v1.001.json" },
"version": { "$ref": "../types/string-required-v1.001.json" },
"sourceId": { "$ref": "../types/guid-required-v1.002.json" },
"id": { "$ref": "../types/guid-required-v1.002.json" },
"correlationId": { "$ref": "../types/guid-required-v1.002.json" },
"tenantId": { "$ref": "../types/guid-required-v1.002.json" },
"ttl":{"$ref": "../types/time-to-live-v1.001.json"},
"command": { "$ref": "../types/string-required-v1.001.json" },
"dateTime": { "$ref": "../types/datetime-v1.001.json" },
"userId": { "$ref": "../types/guid-required-v1.002.json" },
"occurrenceDateTime": {
"allOf": [
{ "$id": "#occurrenceDateTime",
"title": "OccurrenceDateTime",
"description": "The time the event occurred in the real world"
},
{ "$ref": "../types/datetime-v1.001.json" }
]
},
"tags": {
"type": "array",
"items": {
"$ref": "../types/string-required-v1.001.json"
}
}
},
"required": [ "schemaUri", "version", "id", "ttl", "command", "dateTime", "userId" ]
}Header Example
"header": {
"id":"b6e2aef4-3dbf-4f49-a3e2-9c5bcf7a6ad7",
"schemaUri":"https://sv.telesv.com/schemas/CreateExternalCustomData_v1.001.json",
"version":"1.001",
"command":"CreateExternalCustomData",
"sourceId":"f92ec4c6-7046-4dc0-9ab6-cdd3423a7f8c",
"correlationId":"1f9cbe61-9de3-4ab0-b6e6-81cf7b4c35d8",
"tenantId":"75de8cfd-40af-427a-9279-cae6ea33248e",
"dateTime": "2024-08-07T14:20:00Z",
"userId":"40e6ed79-5a1f-4fdc-b340-8a6b7b1a4e72",
"ttl":100000
}Header Definitions
The header section must include the following parameters:
schemaUri string [required]
String with the path to the command schema (same as ID field in schema).
Example: "<https://sv.telesv.com/schemas/CreateExternalCustomData_v1.001.json>"
version string [required]
Version of the command.
Example: "1.001"
sourceId string (GUID)
A GUID uniquely identifying the source of the information. Use the Generated External Source ID found in View Settings under External Source Configuration in the Platform Settings. Use the ID Unique to your sending system. This would be the same sourceID used in the AccessToken payload.
Example: "f92ec4c6-7046-4dc0-9ab6-cdd3423a7f8c"
id string (GUID) [required]
Unique GUID identifying this command instance. Used for tracking and troubleshooting.
Example: "b6e2aef4-3dbf-4f49-a3e2-9c5bcf7a6ad7"
correlationId string (GUID)
GUID used on all generated activity resulting from this command. This can be generated as part of the command or it will be generated at execution.
Example: "b559cb42-2b2a-43de-a9f6-3edbf58d9c45"
tenantId string (GUID)
GUID identifying the sending system. Your unique tenant GUID found in the External Source ID.
Example: "75de8cfd-40af-427a-9279-cae6ea33248e"
ttl integer [required]
Time to live for the command in milliseconds (minimum value: 0).
Example: 10000
command string [required]
The name of the command. In this case CreateExternalCustomData
Example: "CreateExternalCustomData"
dateTime string (date-time format) [required]
Timestamp for when the command is created. Helps troubleshoot delays.
Example: "2024-08-07T14:25:00Z"
userId string (GUID) [required]
GUID for the user initiating the command. Users must manually provide this value by copying their own User ID from the platform when generating the token.
Example: "40e6ed79-5a1f-4fdc-b340-8a6b7b1a4e72"
occurenceDateTime string (date-time format)
The real-world time the data was collected. Defaults to current time if not specified.
Example: "2024-08-07T14:20:00Z"
tags (internal use)
Internal use only, not required for external configuration.
Body Schema
{
"$schema": "http://json-schema.org/draft-07/schema",
"id": "#ExternalCustomData_v1.001",
"type": "object",
"title": "ExternalCustomData",
"properties": {
"id": { "$ref": "../types/guid-required-v1.002.json" },
"externalSource": { "$ref": "../types/string-required-v1.001.json" },
"facilityExternalId": { "$ref": "../types/string-required-v1.001.json"},
"visitExternalId": { "$ref": "../types/string-required-v1.001.json"},
"locationExternalId": { "$ref": "../types/string-required-v1.001.json"},
"patientExternalId": { "$ref": "../types/string-required-v1.001.json"},
"externalDataCategory": { "$ref": "../types/string-required-v1.001.json"},
"externalDataId": { "$ref": "../types/string-required-v1.001.json"},
"externalDataValue": { "$ref": "../types/string-required-v1.001.json"}
},
"required": ["externalSource","externalDataId","externalDataValue"]
}Body Example
"body": {
"externalSource": "PWCDIS",
"facilityExternalId": "101",
"visitExternalId": "VN123456",
"locationExternalId": "Room1",
"patientExternalId": "MRN123456",
"externalDataCategory": "PatientAttribute",
"externalDataId": "UD11",
"externalDataValue": "Combative"
}Body Definitions
ExternalSource string [required]
Unique name of the source issuing the commands. This would be the inbound source. This should match the ID of your inbound source
Example: "PWCDIS"
facilityExternalId string
Unique identifier for the facility that owns the data. Match this with the ADT ID in Capacity Management Suite® which you would have populated for the facility you are sending data in the Facility Dictionary > External Source IDs.
Example: "101"
Facility External Source ID
Enterprise Information ADT ID
visitExternalId string
The VisitNumber uniquely identifying the patient visit.
Example: "VN123456"
locationExternalId string
Identifier for where the data was collected.
Example: "Room1"
patientExternalId string
Unique value identifying the patient, typically an MRN.
Example: "MRN123456"
externalDataCategory string
The type of data being sent. Can only be "PatientAttribute" or "CustomData"
Example: "PatientAttribute"
externalDataId string [required]
Unique identifier representing the key in a key-value pair, typically used to map to a CustomDataType or Patient Attribute within the Capacity Management Suite Dictionary.
This is used to define the metadata key that the data will populate. For example, if populating a patient attribute, externalDataId would map to the ADT Tag Name (e.g., "UD11"), and externalDataValue would provide the corresponding ADT Tag Value.
Example: "UD11"
As shown in the screenshot:
ADT Tag Name = UD11
externalDataValue string [required]
String representation of the value in a key-value pair that corresponds to the key defined in externalDataId.
This field holds the actual data being sent. The value should be expressed as a string and will be interpreted according to the context of the associated key (e.g., a string label, a boolean "true" or "false", or a numeric value). For patient attributes, this might correspond to an ADT Tag Value such as "Combative".
Example: "Combative"
As shown in the screenshot:
ADT Tag Value = Combative
