PFS API FHIR response examples
- Sarah Stuffins
Owned by Sarah Stuffins
This page is a work in progress and the responses are subject to change. These examples are FHIR responses from the GP Data PFS API integration only and is not representative of the full amount of FHIR data available within PKB from other sources.
Contents
Patient
Data Model - Entity: Patient
EMIS - Patient | TPP/SystmOne - Patient |
|---|---|
Example: {
"resource": {
"address": [
{
"use": "home",
"city": "Leeds",
"line": [
"My House",
"2 Micklefield Lane",
"Rawdon"
],
"district": "West Yorkshire",
"postalCode": "LS19 6BA"
}
],
"meta": {
"lastUpdated": "2024-10-30T14:43:40.519128Z",
"versionId": "18",
"extension": [
{
"url": "ex:createdAt",
"valueInstant": "2024-10-30T14:43:40.519128Z"
}
]
},
"managingOrganization": {
"display": "Emis Test Organisation 28826",
"reference": "Organization/A28826"
},
"name": [
{
"use": "official",
"given": [
"Stephen"
],
"family": "Strange",
"prefix": [
"Dr"
]
},
{
"use": "usual",
"given": [
"John"
],
"family": "Strange",
"prefix": [
"Dr"
]
}
],
"birthDate": "1990-01-01",
"resourceType": "Patient",
"active": true,
"id": "0861cf0f-9322-4762-8e02-856a59d86714",
"identifier": [
{
"value": "9994487663",
"system": "https://fhir.nhs.uk/Id/nhs-number"
},
{
"value": "506cfc9d-c90b-469d-a5d2-e97a7062afa5",
"system": "http://fhir.patientsknowbest.com/id/emis-es-patient-guid"
},
{
"value": "7826127e-59bc-4872-b500-b26d3f971b59",
"system": "http://fhir.patientsknowbest.com/id/emis-rosu-patient-guid"
}
],
"telecom": [
{
"use": "home",
"value": "01334567838",
"system": "phone"
},
{
"use": "mobile",
"value": "07123345567",
"system": "phone"
},
{
"use": "home",
"value": "emis_stephen@pkbtest.com",
"system": "email"
}
],
"generalPractitioner": [
{
"display": "Emis Test Organisation 28826",
"reference": "Organization/A28826"
}
],
"gender": "male"
},
"search": {
"mode": "match"
},
"fullUrl": "http://fhir-emis:9443/Patient/0861cf0f-9322-4762-8e02-856a59d86714",
"link": [
{
"relation": "self",
"url": "http://fhir-emis:9443/Patient/0861cf0f-9322-4762-8e02-856a59d86714"
}
]
}
]
} | Example: {
"address": [
{
"use": "home",
"line": [
"1 Low Lane",
"Horsforth",
"Leeds",
"West Yorkshire"
],
"postalCode": "LS18 5PX"
}
],
"meta": {
"lastUpdated": "2024-06-20T10:40:01.029736Z",
"versionId": "15",
"extension": [
{
"url": "ex:createdAt",
"valueInstant": "2024-06-20T10:40:01.029736Z"
}
]
},
"name": [
{
"use": "usual",
"given": [
"Wanda",
"Middle"
],
"family": "Maximoff",
"prefix": [
"Lady"
]
}
],
"birthDate": "1990-01-01",
"resourceType": "Patient",
"active": true,
"id": "c3727dcb-4845-4e07-b9aa-76ba80748de9",
"identifier": [
{
"value": "9996021726",
"system": "https://fhir.nhs.uk/Id/nhs-number"
},
{
"value": "1604600000000000",
"system": "Tpp"
},
{
"value": "QX2Ik8wOn+kRO4zt5D4a0OvU/h7SXiJnXNCmP97e7GQ5sSB0t8Mz7ST/ctYZ2cgcVZdBOAlNdXl3IwMCPV3SiKgxd5wc3e8cQWFyK4l2w/85TJOoZ+JeiAHKh8xIN9pl5gHut2exxHMgatPaLnZuQ2YjvnTXBCE5syraCYURroA=",
"system": "GDI"
}
],
"telecom": [
{
"use": "home",
"value": "01132284729",
"system": "phone"
},
{
"use": "work",
"value": "01733827593",
"system": "phone"
},
{
"use": "mobile",
"value": "07123345567",
"system": "phone"
},
{
"use": "home",
"value": "s1_wanda@pkbtest.com",
"system": "email"
}
],
"generalPractitioner": [
{
"display": "HSCIC Test environment 71",
"reference": "Organization/1b758ac9-6e42-487e-a94a-bd3dd14427d7"
}
],
"gender": "female"
} |
Appointment
Data Model - Entity: Appointment
EMIS - Appointment | TPP/SystmOne - Appointment |
|---|---|
Example: {
"entry": [
{
"resource": {
"meta": {
"lastUpdated": "2024-06-20T10:26:41.929544Z",
"versionId": "58",
"extension": [
{
"url": "ex:createdAt",
"valueInstant": "2024-06-20T10:26:41.929544Z"
}
]
},
"start": "2023-08-18T08:40:00+01:00",
"created": "2023-08-18T00:23:40.753+01:00",
"participant": [
{
"actor": {
"reference": "Patient/10e55609-d188-4174-9887-e7d43aefbc91"
},
"status": "accepted"
},
{
"actor": {
"display": "Master Practice",
"reference": "Location/efb4e00a-be9c-4f76-8b49-c5ea779db845"
},
"status": "accepted",
"required": "required"
}
],
"resourceType": "Appointment",
"status": "booked",
"id": "94cc8290-0d32-4b31-9fbf-fa0f1344b10c",
"identifier": [
{
"value": "10e55609-d188-4174-9887-e7d43aefbc91-656097",
"system": "Emis"
}
],
"end": "2023-08-18T08:50:00+01:00"
},
"search": {
"mode": "match"
},
"fullUrl": "http://fhir-emis:9443/Appointment/94cc8290-0d32-4b31-9fbf-fa0f1344b10c",
"link": [
{
"relation": "self",
"url": "http://fhir-emis:9443/Appointment/94cc8290-0d32-4b31-9fbf-fa0f1344b10c"
}
]
}
]
} | Example: |
Medication
Data Model - Entity: Medication
EMIS - Medication | TPP/SystmOne - Medication |
|---|---|
Condition
Data Model - Entity: Diagnosis
EMIS - Condition | TPP/SystmOne - Condition |
|---|---|
Observation
EMIS - Observation | TPP/SystmOne - Observation |
|---|---|
Allergies
Data model - Entity: Allergy
EMIS - Allergy | TPP/SystmOne - Allergy |
|---|---|
DiagnosticReport
EMIS - DiagnosticReport | TPP/SystmOne - DiagnosticReport |
|---|---|
Immunisation
EMIS - Immunisation | TPP/SystmOne - Immunisation |
|---|---|
|
Document
Data model - Entity: Document
EMIS - Document | TPP/SystmOne - Document |
|---|---|
|
|