Skip to main content

Transfer

Description

A Transfer message is generated when a patient is transferred from one unit to another within a healthcare facility. This event type typically includes information about the patient, such as demographic details, current location, and destination location, as well as any relevant clinical information, such as diagnoses, medications, and b instructions.

API endpoints for Transfer

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-admin/transfer.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Transfer

Transfer - Sample Payload
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Transfer",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "9f4d611d-ce3b-467f-805d-1db9f78b3759",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "34b12038-d111-4365-85cc-e42251ec3956",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "34b12038-d111-4365-85cc-e42251ec3956",
"AttemptID": "4920737b-0a3f-4c8d-b595-4daa98d2076f"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "9692b318-9552-42d5-ad85-a1f0a494e321 ",
"IDType": "EHRID"
},
{
"ID": "a398ca32-fb09-463a-bb5b-bcfbe80d4e7c",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "John",
"MiddleName": "Henry",
"LastName": "Franklin",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18036675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "1234 High Street",
"City": "San Jose",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Sara",
"MiddleName": null,
"LastName": "Franklin",
"Address": {
"StreetAddress": "4762 High Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": "+18009675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"sara.f@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Throat infection",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin-II",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Davis",
"LastName": "Wilson",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2022-08-16T14:21:21.513Z",
"DischargeDateTime": null,
"DischargeStatus": {
"Code": "09",
"Codeset": "UB04FL17",
"Description": "Admitted to hospital"
},
"Duration": 30,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"DiagnosisRelatedGroup": null,
"DiagnosisRelatedGroupType": null,
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Davis",
"LastName": "Wilson",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"AdmittingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"AdditionalStaff": [],
"Location": {
"Type": "Inpatient",
"Facility": "MES Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "9509 Ring Ln",
"City": "San Jose"",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
}
},
"PreviousLocation": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null,
"Bed": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Allen",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Gracy",
"LastName": "Allen"
},
"Address": {
"StreetAddress": "4762 High Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Digitech Labs",
"Address": {
"StreetAddress": "1456 Old Hill Road",
"City": "San Jose"",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMOPlan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "San Jose"",
"State": "CA",
"ZIP": "40512-4079",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Digitech Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"Priority": null,
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}