Virtual Visits
Creating a new virtual visit
View visit
POST https://dev-api.sehhati.ae/fhir/$process-message
enable provider to view visit details by id
Request Body
content*
string
task resource containing appointment details to be fetched
{
"resourceType": "Bundle",
"id": "777a156c-af3c-4748-a8a3-7e95e4b0df9a",
"meta": {
"versionId": "1.0.0-alpha",
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/StructureDefinition/BARSBundleMessage"
]
},
"type": "message",
"timestamp": "2021-10-11T12:15:10+00:00",
"entry": [
{
"fullUrl": "urn:uuid:c5957fdd-097b-409d-a406-49c52ceef2cd",
"resource": {
"resourceType": "MessageHeader",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/StructureDefinition/BARSMessageHeader-booking-request"
]
},
"eventCoding": {
"system": "https://api.sehatuk.ae/CodeSystem/message-events-bars",
"code": "booking-request"
},
"destination": [
{
"endpoint": "http://api.sehatuk.ae/Id/dos-service-id|111111111",
"receiver": {
"reference": "urn:uuid:43a42f7a-a6f2-42a5-a8f0-fc85abf8c3fa"
}
}
],
"sender": {
"reference": "urn:uuid:6324587b-eb70-4333-9db2-22d48f64c9ba"
},
"source": {
"name": "My organisation name",
"software": "My software name",
"version": "2.1.45",
"contact": {
"system": "phone",
"value": "+44 (0113) 123 4567"
},
"endpoint": "http://api.sehatuk.ae/Id/dos-service-id|2222222222"
},
"reason": {
"coding": [
{
"system": "https://api.sehatuk.ae/CodeSystem/message-reason-bars",
"code": "new"
}
]
},
"focus": [
{
"reference": "urn:uuid:aca94bdb-2e38-4399-9ece-2ba083ce65b5"
}
],
"definition": "https://api.sehatuk.ae/MessageDefinition/bars-message-booking-request"
}
},
{
"fullUrl": "urn:uuid:aca94bdb-2e38-4399-9ece-2ba083ce65b5",
"resource": {
"resourceType": "Appointment",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Appointment",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Appointment"
]
},
"status": "booked",
"description": "Reason for calling-",
"start": "2021-10-12T12:30:30+00:00",
"end": "2021-10-12T12:40:30+00:00",
"slot": [
{
"reference": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda"
}
],
"created": "2021-10-11T15:01:30+00:00",
"participant": [
{
"actor": {
"reference": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2"
},
"status": "accepted"
}
]
}
},
{
"fullUrl": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2",
"resource": {
"resourceType": "Patient",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Patient"
]
},
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionEthnicCategory",
"valueCodeableConcept": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-EthnicCategory",
"code": "A",
"display": "British, Mixed British"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-religion",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation",
"code": "1041",
"display": "Roman Catholic Church"
}
]
}
}
],
"identifier": [
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionNumberVerificationStatus",
"valueCodeableConcept": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-NumberVerificationStatus",
"code": "number-present-and-verified",
"display": "Number present and verified"
}
]
}
}
],
"system": "https://api.sehatuk.ae/Id/id-number",
"value": "9476719931"
}
],
"name": [
{
"use": "official",
"text": "Mr Peter Chalmers",
"family": "Chalmers",
"given": [
"Peter"
],
"prefix": [
"Mr"
]
}
],
"gender": "male",
"birthDate": "1974-12-25",
"address": [
{
"use": "home",
"text": "123 High Street, Leeds LS1 4HR",
"line": [
"123 High Street",
"Leeds"
],
"city": "Leeds",
"postalCode": "LS1 4HR"
}
],
"contact": [
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionContactRank",
"valuePositiveInt": 1
}
],
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "ONESELF"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "01138698975",
"use": "home",
"rank": 2
},
{
"system": "phone",
"value": "07736312544",
"use": "mobile",
"rank": 1
},
{
"system": "email",
"value": "[email protected]",
"use": "home",
"rank": 1
}
]
},
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-ContactRank",
"valuePositiveInt": 2
}
],
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "NEPHEW"
}
]
}
],
"name": {
"family": "Grayson",
"given": [
"Jack"
]
},
"telecom": [
{
"system": "phone",
"value": "0789 1234567",
"rank": 1
}
],
"gender": "male"
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-HumanLanguage",
"code": "en",
"display": "English"
}
]
},
"preferred": true
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:c8c21609-cb27-4958-8eb2-37c76f3def85"
}
]
}
},
{
"fullUrl": "urn:uuid:c8c21609-cb27-4958-8eb2-37c76f3def85",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"identifier": [
{
"system": "https://api.sehatuk.ae/id/ods-organization-code",
"value": "G82080"
}
],
"name": "Patient's Surgery"
}
},
{
"fullUrl": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda",
"resource": {
"resourceType": "Slot",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Slot",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Slot"
]
},
"serviceCategory": [
{
"coding": [
{
"code": "14",
"display": "Emergency Department"
}
]
}
],
"appointmentType": {
"coding": [
{
"code": "EMERGENCY",
"display": "Emergency appointment"
}
]
},
"schedule": {
"reference": "urn:uuid:3a62607b-df65-4932-940c-14262787f62d"
},
"status": "busy",
"start": "2021-10-06T10:00:00.000+00:00",
"end": "2021-10-06T11:00:00.000+00:00"
}
},
{
"fullUrl": "urn:uuid:3a62607b-df65-4932-940c-14262787f62d",
"resource": {
"resourceType": "Schedule",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Schedule",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Schedule"
]
},
"identifier": [
{
"system": "https://system.supplier.co.uk/Diary/id",
"value": "8622dfdb-dc6a-47b6-b3a7-2eb2829db287"
}
],
"actor": [
{
"reference": "urn:uuid:e5fd53eb-7b1d-496d-bbf8-5c9dc7bd761b"
},
{
"reference": "urn:uuid:52428e73-0a5c-455d-8ff5-cd080e557082"
},
{
"reference": "urn:uuid:6daaadd8-56e0-4d74-8350-1632331c5452"
}
]
}
},
{
"fullUrl": "urn:uuid:e5fd53eb-7b1d-496d-bbf8-5c9dc7bd761b",
"resource": {
"resourceType": "HealthcareService",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-HealthcareService"
]
},
"identifier": [
{
"system": "https://system.supplier.co.uk/My/Healthcare/Services",
"value": "100"
}
],
"location": [
{
"reference": "urn:uuid:860e4c37-4e36-45fb-8fca-41132cd937a5"
}
],
"name": "Healthcare Service Name"
}
},
{
"fullUrl": "urn:uuid:6daaadd8-56e0-4d74-8350-1632331c5452",
"resource": {
"resourceType": "Practitioner",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Practitioner"
]
},
"name": [
{
"family": "Bloggs",
"given": [
"Joe"
],
"prefix": [
"Dr"
]
}
]
}
},
{
"fullUrl": "urn:uuid:52428e73-0a5c-455d-8ff5-cd080e557082",
"resource": {
"resourceType": "PractitionerRole",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-PractitionerRole"
]
},
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
"code": "doctor",
"display": "Doctor"
}
]
}
]
}
},
{
"fullUrl": "urn:uuid:860e4c37-4e36-45fb-8fca-41132cd937a5",
"resource": {
"resourceType": "Location",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Location"
]
},
"name": "Healthcare Service Location",
"position": {
"longitude": 143.20196,
"latitude": -37.22866
}
}
},
{
"fullUrl": "urn:uuid:43a42f7a-a6f2-42a5-a8f0-fc85abf8c3fa",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"name": "ORIGINAL Receiving/performing Organization"
}
},
{
"fullUrl": "urn:uuid:6324587b-eb70-4333-9db2-22d48f64c9ba",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"name": "ORIGINAL Sender Organization"
}
}
]
}n{
// Response
}Create virtual visit
POST https://dev-api.sehhati.ae/fhir/$process-message
Creates a new visit.
Request Body
content*
string
bundle resource containing booking details
{
"resourceType": "Bundle",
"id": "777a156c-af3c-4748-a8a3-7e95e4b0df9a",
"meta": {
"versionId": "1.0.0-alpha",
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/StructureDefinition/BARSBundleMessage"
]
},
"type": "message",
"timestamp": "2021-10-11T12:15:10+00:00",
"entry": [
{
"fullUrl": "urn:uuid:c5957fdd-097b-409d-a406-49c52ceef2cd",
"resource": {
"resourceType": "MessageHeader",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/StructureDefinition/BARSMessageHeader-booking-request"
]
},
"eventCoding": {
"system": "https://api.sehatuk.ae/CodeSystem/message-events-bars",
"code": "booking-request"
},
"destination": [
{
"endpoint": "http://api.sehatuk.ae/Id/dos-service-id|111111111",
"receiver": {
"reference": "urn:uuid:43a42f7a-a6f2-42a5-a8f0-fc85abf8c3fa"
}
}
],
"sender": {
"reference": "urn:uuid:6324587b-eb70-4333-9db2-22d48f64c9ba"
},
"source": {
"name": "My organisation name",
"software": "My software name",
"version": "2.1.45",
"contact": {
"system": "phone",
"value": "+44 (0113) 123 4567"
},
"endpoint": "http://api.sehatuk.ae/Id/dos-service-id|2222222222"
},
"reason": {
"coding": [
{
"system": "https://api.sehatuk.ae/CodeSystem/message-reason-bars",
"code": "new"
}
]
},
"focus": [
{
"reference": "urn:uuid:aca94bdb-2e38-4399-9ece-2ba083ce65b5"
}
],
"definition": "https://api.sehatuk.ae/MessageDefinition/bars-message-booking-request"
}
},
{
"fullUrl": "urn:uuid:aca94bdb-2e38-4399-9ece-2ba083ce65b5",
"resource": {
"resourceType": "Appointment",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Appointment",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Appointment"
]
},
"status": "booked",
"description": "Reason for calling-",
"start": "2021-10-12T12:30:30+00:00",
"end": "2021-10-12T12:40:30+00:00",
"slot": [
{
"reference": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda"
}
],
"created": "2021-10-11T15:01:30+00:00",
"participant": [
{
"actor": {
"reference": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2"
},
"status": "accepted"
}
]
}
},
{
"fullUrl": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2",
"resource": {
"resourceType": "Patient",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Patient"
]
},
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionEthnicCategory",
"valueCodeableConcept": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-EthnicCategory",
"code": "A",
"display": "British, Mixed British"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-religion",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation",
"code": "1041",
"display": "Roman Catholic Church"
}
]
}
}
],
"identifier": [
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionNumberVerificationStatus",
"valueCodeableConcept": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-NumberVerificationStatus",
"code": "number-present-and-verified",
"display": "Number present and verified"
}
]
}
}
],
"system": "https://api.sehatuk.ae/Id/id-number",
"value": "9476719931"
}
],
"name": [
{
"use": "official",
"text": "Mr Peter Chalmers",
"family": "Chalmers",
"given": [
"Peter"
],
"prefix": [
"Mr"
]
}
],
"gender": "male",
"birthDate": "1974-12-25",
"address": [
{
"use": "home",
"text": "123 High Street, Leeds LS1 4HR",
"line": [
"123 High Street",
"Leeds"
],
"city": "Leeds",
"postalCode": "LS1 4HR"
}
],
"contact": [
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionContactRank",
"valuePositiveInt": 1
}
],
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "ONESELF"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "01138698975",
"use": "home",
"rank": 2
},
{
"system": "phone",
"value": "07736312544",
"use": "mobile",
"rank": 1
},
{
"system": "email",
"value": "[email protected]",
"use": "home",
"rank": 1
}
]
},
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-ContactRank",
"valuePositiveInt": 2
}
],
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "NEPHEW"
}
]
}
],
"name": {
"family": "Grayson",
"given": [
"Jack"
]
},
"telecom": [
{
"system": "phone",
"value": "0789 1234567",
"rank": 1
}
],
"gender": "male"
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-HumanLanguage",
"code": "en",
"display": "English"
}
]
},
"preferred": true
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:c8c21609-cb27-4958-8eb2-37c76f3def85"
}
]
}
},
{
"fullUrl": "urn:uuid:c8c21609-cb27-4958-8eb2-37c76f3def85",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"identifier": [
{
"system": "https://api.sehatuk.ae/id/ods-organization-code",
"value": "G82080"
}
],
"name": "Patient's Surgery"
}
},
{
"fullUrl": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda",
"resource": {
"resourceType": "Slot",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Slot",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Slot"
]
},
"serviceCategory": [
{
"coding": [
{
"code": "14",
"display": "Emergency Department"
}
]
}
],
"appointmentType": {
"coding": [
{
"code": "EMERGENCY",
"display": "Emergency appointment"
}
]
},
"schedule": {
"reference": "urn:uuid:3a62607b-df65-4932-940c-14262787f62d"
},
"status": "busy",
"start": "2021-10-06T10:00:00.000+00:00",
"end": "2021-10-06T11:00:00.000+00:00"
}
},
{
"fullUrl": "urn:uuid:3a62607b-df65-4932-940c-14262787f62d",
"resource": {
"resourceType": "Schedule",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Schedule",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Schedule"
]
},
"identifier": [
{
"system": "https://system.supplier.co.uk/Diary/id",
"value": "8622dfdb-dc6a-47b6-b3a7-2eb2829db287"
}
],
"actor": [
{
"reference": "urn:uuid:e5fd53eb-7b1d-496d-bbf8-5c9dc7bd761b"
},
{
"reference": "urn:uuid:52428e73-0a5c-455d-8ff5-cd080e557082"
},
{
"reference": "urn:uuid:6daaadd8-56e0-4d74-8350-1632331c5452"
}
]
}
},
{
"fullUrl": "urn:uuid:e5fd53eb-7b1d-496d-bbf8-5c9dc7bd761b",
"resource": {
"resourceType": "HealthcareService",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-HealthcareService"
]
},
"identifier": [
{
"system": "https://system.supplier.co.uk/My/Healthcare/Services",
"value": "100"
}
],
"location": [
{
"reference": "urn:uuid:860e4c37-4e36-45fb-8fca-41132cd937a5"
}
],
"name": "Healthcare Service Name"
}
},
{
"fullUrl": "urn:uuid:6daaadd8-56e0-4d74-8350-1632331c5452",
"resource": {
"resourceType": "Practitioner",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Practitioner"
]
},
"name": [
{
"family": "Bloggs",
"given": [
"Joe"
],
"prefix": [
"Dr"
]
}
]
}
},
{
"fullUrl": "urn:uuid:52428e73-0a5c-455d-8ff5-cd080e557082",
"resource": {
"resourceType": "PractitionerRole",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-PractitionerRole"
]
},
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
"code": "doctor",
"display": "Doctor"
}
]
}
]
}
},
{
"fullUrl": "urn:uuid:860e4c37-4e36-45fb-8fca-41132cd937a5",
"resource": {
"resourceType": "Location",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Location"
]
},
"name": "Healthcare Service Location",
"position": {
"longitude": 143.20196,
"latitude": -37.22866
}
}
},
{
"fullUrl": "urn:uuid:43a42f7a-a6f2-42a5-a8f0-fc85abf8c3fa",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"name": "ORIGINAL Receiving/performing Organization"
}
},
{
"fullUrl": "urn:uuid:6324587b-eb70-4333-9db2-22d48f64c9ba",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"name": "ORIGINAL Sender Organization"
}
}
]
}nupdate virtual visit
POST https://dev-api.sehhati.ae/fhir/$process-message
update/cancel a scheduled visit.
Request Body
content*
string
bundle resource containing booking details
{
"resourceType": "Bundle",
"id": "777a156c-af3c-4748-a8a3-7e95e4b0df9a",
"meta": {
"versionId": "1.0.0-alpha",
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/StructureDefinition/BARSBundleMessage"
]
},
"type": "message",
"timestamp": "2021-10-11T12:15:10+00:00",
"entry": [
{
"fullUrl": "urn:uuid:c5957fdd-097b-409d-a406-49c52ceef2cd",
"resource": {
"resourceType": "MessageHeader",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/StructureDefinition/BARSMessageHeader-booking-request"
]
},
"eventCoding": {
"system": "https://api.sehatuk.ae/CodeSystem/message-events-bars",
"code": "booking-request"
},
"destination": [
{
"endpoint": "http://api.sehatuk.ae/Id/dos-service-id|111111111",
"receiver": {
"reference": "urn:uuid:43a42f7a-a6f2-42a5-a8f0-fc85abf8c3fa"
}
}
],
"sender": {
"reference": "urn:uuid:6324587b-eb70-4333-9db2-22d48f64c9ba"
},
"source": {
"name": "My organisation name",
"software": "My software name",
"version": "2.1.45",
"contact": {
"system": "phone",
"value": "+44 (0113) 123 4567"
},
"endpoint": "http://api.sehatuk.ae/Id/dos-service-id|2222222222"
},
"reason": {
"coding": [
{
"system": "https://api.sehatuk.ae/CodeSystem/message-reason-bars",
"code": "new"
}
]
},
"focus": [
{
"reference": "urn:uuid:aca94bdb-2e38-4399-9ece-2ba083ce65b5"
}
],
"definition": "https://api.sehatuk.ae/MessageDefinition/bars-message-booking-request"
}
},
{
"fullUrl": "urn:uuid:aca94bdb-2e38-4399-9ece-2ba083ce65b5",
"resource": {
"resourceType": "Appointment",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Appointment",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Appointment"
]
},
"status": "booked",
"description": "Reason for calling-",
"start": "2021-10-12T12:30:30+00:00",
"end": "2021-10-12T12:40:30+00:00",
"slot": [
{
"reference": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda"
}
],
"created": "2021-10-11T15:01:30+00:00",
"participant": [
{
"actor": {
"reference": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2"
},
"status": "accepted"
}
]
}
},
{
"fullUrl": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2",
"resource": {
"resourceType": "Patient",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Patient"
]
},
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionEthnicCategory",
"valueCodeableConcept": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-EthnicCategory",
"code": "A",
"display": "British, Mixed British"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-religion",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation",
"code": "1041",
"display": "Roman Catholic Church"
}
]
}
}
],
"identifier": [
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionNumberVerificationStatus",
"valueCodeableConcept": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-NumberVerificationStatus",
"code": "number-present-and-verified",
"display": "Number present and verified"
}
]
}
}
],
"system": "https://api.sehatuk.ae/Id/id-number",
"value": "9476719931"
}
],
"name": [
{
"use": "official",
"text": "Mr Peter Chalmers",
"family": "Chalmers",
"given": [
"Peter"
],
"prefix": [
"Mr"
]
}
],
"gender": "male",
"birthDate": "1974-12-25",
"address": [
{
"use": "home",
"text": "123 High Street, Leeds LS1 4HR",
"line": [
"123 High Street",
"Leeds"
],
"city": "Leeds",
"postalCode": "LS1 4HR"
}
],
"contact": [
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/ExtensionContactRank",
"valuePositiveInt": 1
}
],
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "ONESELF"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "01138698975",
"use": "home",
"rank": 2
},
{
"system": "phone",
"value": "07736312544",
"use": "mobile",
"rank": 1
},
{
"system": "email",
"value": "[email protected]",
"use": "home",
"rank": 1
}
]
},
{
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-ContactRank",
"valuePositiveInt": 2
}
],
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "NEPHEW"
}
]
}
],
"name": {
"family": "Grayson",
"given": [
"Jack"
]
},
"telecom": [
{
"system": "phone",
"value": "0789 1234567",
"rank": 1
}
],
"gender": "male"
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "https://api.sehatuk.ae/uae-fhir/r4/CodeSystem-HumanLanguage",
"code": "en",
"display": "English"
}
]
},
"preferred": true
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:c8c21609-cb27-4958-8eb2-37c76f3def85"
}
]
}
},
{
"fullUrl": "urn:uuid:c8c21609-cb27-4958-8eb2-37c76f3def85",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"identifier": [
{
"system": "https://api.sehatuk.ae/id/ods-organization-code",
"value": "G82080"
}
],
"name": "Patient's Surgery"
}
},
{
"fullUrl": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda",
"resource": {
"resourceType": "Slot",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Slot",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Slot"
]
},
"serviceCategory": [
{
"coding": [
{
"code": "14",
"display": "Emergency Department"
}
]
}
],
"appointmentType": {
"coding": [
{
"code": "EMERGENCY",
"display": "Emergency appointment"
}
]
},
"schedule": {
"reference": "urn:uuid:3a62607b-df65-4932-940c-14262787f62d"
},
"status": "busy",
"start": "2021-10-06T10:00:00.000+00:00",
"end": "2021-10-06T11:00:00.000+00:00"
}
},
{
"fullUrl": "urn:uuid:3a62607b-df65-4932-940c-14262787f62d",
"resource": {
"resourceType": "Schedule",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Schedule",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Schedule"
]
},
"identifier": [
{
"system": "https://system.supplier.co.uk/Diary/id",
"value": "8622dfdb-dc6a-47b6-b3a7-2eb2829db287"
}
],
"actor": [
{
"reference": "urn:uuid:e5fd53eb-7b1d-496d-bbf8-5c9dc7bd761b"
},
{
"reference": "urn:uuid:52428e73-0a5c-455d-8ff5-cd080e557082"
},
{
"reference": "urn:uuid:6daaadd8-56e0-4d74-8350-1632331c5452"
}
]
}
},
{
"fullUrl": "urn:uuid:e5fd53eb-7b1d-496d-bbf8-5c9dc7bd761b",
"resource": {
"resourceType": "HealthcareService",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-HealthcareService"
]
},
"identifier": [
{
"system": "https://system.supplier.co.uk/My/Healthcare/Services",
"value": "100"
}
],
"location": [
{
"reference": "urn:uuid:860e4c37-4e36-45fb-8fca-41132cd937a5"
}
],
"name": "Healthcare Service Name"
}
},
{
"fullUrl": "urn:uuid:6daaadd8-56e0-4d74-8350-1632331c5452",
"resource": {
"resourceType": "Practitioner",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Practitioner"
]
},
"name": [
{
"family": "Bloggs",
"given": [
"Joe"
],
"prefix": [
"Dr"
]
}
]
}
},
{
"fullUrl": "urn:uuid:52428e73-0a5c-455d-8ff5-cd080e557082",
"resource": {
"resourceType": "PractitionerRole",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-PractitionerRole"
]
},
"code": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
"code": "doctor",
"display": "Doctor"
}
]
}
]
}
},
{
"fullUrl": "urn:uuid:860e4c37-4e36-45fb-8fca-41132cd937a5",
"resource": {
"resourceType": "Location",
"meta": {
"lastUpdated": "2021-10-11T15:01:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Location"
]
},
"name": "Healthcare Service Location",
"position": {
"longitude": 143.20196,
"latitude": -37.22866
}
}
},
{
"fullUrl": "urn:uuid:43a42f7a-a6f2-42a5-a8f0-fc85abf8c3fa",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"name": "ORIGINAL Receiving/performing Organization"
}
},
{
"fullUrl": "urn:uuid:6324587b-eb70-4333-9db2-22d48f64c9ba",
"resource": {
"resourceType": "Organization",
"meta": {
"lastUpdated": "2021-10-11T15:23:30+00:00",
"profile": [
"https://api.sehatuk.ae/uae-fhir/r4/StructureDefinition-Organization"
]
},
"name": "ORIGINAL Sender Organization"
}
}
]
}nSend visit notes
POST https://dev-api.sehhati.ae/fhir/$process-message
Send visit summary notes
Request Body
content*
string
bundle resource containing summary details
Send visit events
POST https://dev-api.sehhati.ae/fhir/$process-message
Send visit events like patient arrived, patient left, patient didn't show
Request Body
content*
string
bundle resource containing summary details
Find Appointment Slots
POST https://dev-api.sehhati.ae/fhir/$process-message
Find appointment slot for patient
Request Body
content*
string
bundle resource containing criteria for finding the booking slot like date range and serviceType
Last updated