Search examples
We have developed a number of example searches that demonstrate the different ways a consumer may request data in GP Connect. These have been created in conjunction with our clinical team to demonstrate the possible ways of requesting similar data that we anticipate consumers are likely to require.
The different approaches to requests that will return similar information have been chosen here to demonstrate the filter constraints that we have imposed to mitigate the risk described here in the Search criteria page.
Request allergies and medications from the last year
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeMedication",
"part": [
{
"name": "medicationSearchFromDate",
"valueDate": "2019-02-21"
}
]
}
]
}
Request medications for the last year, allergies and problems
- If done in one query then all medications would be returned, no date filter could be applied:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeMedication"
}
]
},
{
"name": "includeProblems"
}
- If done in two separate queries, the first would return allergies and problems and the second would return medications for the last year:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeProblems"
}
]
}
AND
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeMedication",
"part": [
{
"name": "medicationSearchFromDate",
"valueDate": "2019-02-21"
}
]
}
]
}
Request a patient’s last three consultations
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeConsultations",
"part": [
{
"name": "includeNumberOfMostRecent",
"valuePositiveInt": 3
}
]
}
]
}
Request a patient’s last three consultations with problems, medications and allergies
- If done in one query then all medications would be returned, no date filter could be applied:
{
"resourceType":"Parameters",
"parameter":[
{
"name":"patientNHSNumber",
"valueIdentifier":{
"system":"https://fhir.nhs.uk/Id/nhs-number",
"value":"9999999999"
}
},
{
"name":"includeConsultations",
"part":[
{
"name":"includeNumberOfMostRecent",
"valuePositiveInt":3
}
]
},
{
"name":"includeProblems"
},
{
"name":"includeAllergies",
"part":[
{
"name":"includeResolvedAllergies",
"valueBoolean":true
}
]
},
{
"name":"includeMedication"
}
]
}
- If done in two separate queries, the first would retrieve the last three consultations and problems and the second would retrieve allergies and medications for the last year:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeConsultations",
"part": [
{
"name": "includeNumberOfMostRecent",
"valuePositiveInt": 3
}
]
},
{
"name": "includeProblems"
}
]
}
AND
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeMedication",
"part": [
{
"name": "medicationSearchFromDate",
"valueDate": "2019-12-21"
}
]
}
]
}
Request child health information, medication, allergies, immunisations, problems and observations
- If done in one query this would retrieve all medications and observations, no filters could be applied:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeMedication"
},
{
"name": "includeProblems"
},
{
"name": "includeImmunisations"
},
{
"name": "includeUncategorisedData"
}
]
}
- If done in two queries this would get last year of medications, all allergies, problems, immunisations and observations:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeMedication",
"part": [
{
"name": "medicationSearchFromDate",
"valueDate": "2019-12-21"
}
]
}
]
}
AND
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeProblems"
},
{
"name": "includeImmunisations"
},
{
"name": "includeUncategorisedData"
}
]
}
- Another option would be two queries where the first retrieves the last year of medications and observations and the second retrieves all allergies, problems and immunisations:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeMedication",
"part": [
{
"name": "medicationSearchFromDate",
"valueDate": "2019-12-21"
}
]
},
{
"name": "includeUncategorisedData",
"part": [
{
"name": "uncategorisedDataSearchPeriod",
"valuePeriod": {
"start": "2019-12-21",
"end": "2020-02-21"
}
}
]
}
]
}
AND
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeProblems"
},
{
"name": "includeImmunisations"
}
]
}
Request all information that has been recorded for the patient in the last three months
- If done in one query this would return everything, no date filter could be applied on medications, observations, investigations, referrals or diary entries:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeMedication"
},
{
"name": "includeConsultations",
"part": [
{
"name": "consultationSearchPeriod",
"valuePeriod": {
"start": "2019-12-21",
"end": "2020-02-21"
}
}
]
},
{
"name": "includeProblems"
},
{
"name": "includeImmunisations"
},
{
"name": "includeUncategorisedData"
},
{
"name": "includeInvestigations"
},
{
"name": "includeReferrals"
},
{
"name": "includeDiaryEntries"
}
]
}
- If done in two queries this would be a query for the last three months for observations, medications, investigations, referrals and diary entries and a second query for the last three months’ consultations and all allergies, problems and immunisations:
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeMedication",
"part": [
{
"name": "medicationSearchFromDate",
"valueDate": "2019-12-21"
}
]
},
{
"name": "includeUncategorisedData",
"part": [
{
"name": "uncategorisedDataSearchPeriod",
"valuePeriod": {
"start": "2019-12-21",
"end": "2020-02-21"
}
}
]
},
{
"name": "includeInvestigations",
"part": [
{
"name": "investigationSearchPeriod",
"valuePeriod": {
"start": "2019-12-21",
"end": "2020-02-21"
}
}
]
},
{
"name": "includeReferrals",
"part": [
{
"name": "referralSearchPeriod",
"valuePeriod": {
"start": "2019-12-21",
"end": "2020-02-21"
}
}
]
},
{
"name": "includeDiaryEntries",
"part": [
{
"name": "diaryEntriesSearchDate",
"valueDate": "2019-12-21"
}
]
}
]
}
AND
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientNHSNumber",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
},
{
"name": "includeConsultations",
"part": [
{
"name": "consultationSearchPeriod",
"valuePeriod": {
"start": "2019-12-21",
"end": "2020-02-21"
}
}
]
},
{
"name": "includeAllergies",
"part": [
{
"name": "includeResolvedAllergies",
"valueBoolean": true
}
]
},
{
"name": "includeProblems"
},
{
"name": "includeImmunisations"
}
]
}