Skip to main content

Update

API endpoints for Organization Update

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/organizations/update.

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

Data Model JSON for Update

Update - Sample Payload
{
"Meta": {
"DataModel": "Organization",
"EventType": "Update",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "57586ad9-96a5-48be-8858-2170c4799014",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "70f3bea4-ea09-498a-967c-54750c27e2ef",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "30762576-14f2-465a-bd08-fc59d1517468 ",
"AttemptID": "f1ef42dc-0d61-4dc6-8ccf-6d8d8aacb6ab"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Action": "Update",
"Directory": "Quality Care",
"Organizations": [
{
"Active": true,
"Name": "Test Org",
"Aliases": [],
"Identifiers": [
{
"ID": "0000000001",
"IDType": "FACID"
},
{
"ID": "1.2.3.4.5",
"IDType": "OID"
}
],
"Type": {
"System": "http://hl7.org/fhir/organization-type",
"Value": "Implementer"
},
"PartOf": {
"Identifier": {
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "1.2.3.4"
}
},
"Contacts": [
{
"Purpose": null,
"Name": "John, Wilson",
"EmailAddresses": [
"john.wilson@test.net"
],
"PhoneNumber": {
"Home": "+18009675303",
"Work": null,
"Mobile": "+19239368865"
}
}
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose",
"State": "CA",
"ZIP": "86754",
"County": "Santa Clara",
"Country": "USA"
},
"Endpoints": [
{
"Identifiers": [
{
"Type": "HCID",
"System": "http://www.hl7.org/oid/",
"Value": "2.8.1.2"
}
],
"ConnectionType": {
"System": "http://hl7.org/fhir/subscription-channel-type",
"Value": "ihe-xcpd"
},
"Name": "Patient Discovery",
"Address": "https://fake.fake.com/xcpd",
"MIMEType": "Text/XML",
"Attributes": {
"Transaction": "XCPD ITI-55",
"Actor": {
"System": "https://example.org/api/Actor/1.0.0",
"Value": "Responding Gateway"
},
"Version": {
"System": "https://example.org/api/Version/1.0.0",
"Value": "2.0"
},
"UseCases": [
{
"System": "https://example.org/api/UseCases/1.0.0",
"Value": "QueryBasedDocumentExchange"
}
],
"PurposeOfUse": [
{
"System": "https://example.org/api/Purpose/1.0.0",
"Value": "Treatment"
}
],
"Roles": [
{
"System": "https://example.org/api/Roles/1.0.0",
"Value": "All"
}
]
}
}
],
"DestinationID": "ba8ef175-fb22-478e-a2cb-67c882fd813a"
}
]
}