Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


FHIR® (Diary Entry) ProcedureRequest examples

Access Record Structured FHIR examples

The following is a set of request/response examples for (Diary Entry) ProcedureRequest:

Example 1

Request

Example of a call to return the following items from a patient's structured record:

  • (Diary Entry) ProcedureRequest

Request payload

{
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1"
    ]
  },
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "patientNHSNumber",
      "valueIdentifier": {
        "system": "https://fhir.nhs.uk/Id/nhs-number",
        "value": "9999999999"
      }
    },
    {
      "name": "includeDiaryEntries",
	  "part": [
        {
          "name": "diaryEntriesSearchDate",
          "valueDate": "2017-06-04"
        }
      ]
    }
  ]
}

Response payload

{
  "resourceType": "Bundle",
  "type": "collection",
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1"
    ]
  },
  "entry": [
    {
      "resource": {
        "resourceType": "Patient",
        "id": "04603d77-1a4e-4d63-b246-d7504f8bd833",
        "meta": {
          "versionId": "1469448000000",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
          ]
        },
        "extension": [
          {
            "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-RegistrationDetails-1",
            "extension": [
              {
                "url": "registrationPeriod",
                "valuePeriod": {
                  "start": "1962-07-13T00:00:00+00:00"
                }
              }
            ]
          }
        ],
        "identifier": [
          {
            "extension": [
              {
                "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-NHSNumberVerificationStatus-1",
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "https://fhir.nhs.uk/CareConnect-NHSNumberVerificationStatus-1",
                      "code": "01",
                      "display": "Number present and verified"
                    }
                  ]
                }
              }
            ],
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9999999999"
          }
        ],
        "active": true,
        "name": [
          {
            "use": "official",
            "text": "JACKSON Jane (Miss)",
            "family": "Jackson",
            "given": [
              "Jane"
            ],
            "prefix": [
              "Miss"
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "01454587554",
            "use": "home"
          }
        ],
        "gender": "female",
        "birthDate": "1952-05-31",
        "address": [
          {
            "use": "home",
            "type": "physical",
            "line": [
              "Cable Place",
              "Roundhay"
            ],
            "city": "Leeds",
            "district": "West Yorkshire",
            "postalCode": "LS1 5HT"
          }
        ],
        "generalPractitioner": {
          "reference": "Practitioner/6c41ebfd-57c3-4162-9d7b-208c171a2fd7"
        },
        "managingOrganization": {
          "reference": "Organization/db67f447-b30d-442a-8e31-6918d1367eeb"
        }
      }
    },
    {
      "resource": {
        "resourceType": "Organization",
        "id": "db67f447-b30d-442a-8e31-6918d1367eeb",
        "meta": {
          "versionId": "636064088098730113",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
          ]
        },
        "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "O001"
          }
        ],
        "name": "The Trevelyan Practice",
        "address": [
          {
            "line": [
              "Trevelyan Square",
              "Boar Ln"
            ],
            "city": "Leeds",
            "district": "West Yorkshire",
            "postalCode": "LS1 6AE"
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "03003035678",
            "use": "work"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Practitioner",
        "id": "6c41ebfd-57c3-4162-9d7b-208c171a2fd7",
        "meta": {
          "versionId": "1469448000000",
          "lastUpdated": "2016-07-25T12:00:00.000+00:00",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
          ]
        },
        "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "G13579135"
          }
        ],
        "name": [
          {
            "use": "usual",
            "family": "Gilbert",
            "given": [
              "Nichole"
            ],
            "prefix": [
              "Miss"
            ]
          }
        ],
        "gender": "female"
      }
    },
    {
      "resource": {
        "meta": {
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-PractitionerRole-1"
          ]
        },
        "resourceType": "PractitionerRole",
        "id": "e0244de8-07ef-4274-9f7a-d7067bcc8d21",
        "practitioner": {
          "reference": "Practitioner/6c41ebfd-57c3-4162-9d7b-208c171a2fd7"
        },
        "organization": {
          "reference": "Organization/db67f447-b30d-442a-8e31-6918d1367eeb"
        },
        "code": [
          {
            "coding": [
              {
                "system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
                "code": "R0260",
                "display": "General Medical Practitioner"
              }
            ]
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Location",
        "id": "17",
        "meta": {
          "versionId": "636064088100870233",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1"
          ]
        },
        "name": "The Trevelyan Practice",
        "address": {
          "line": [
            "Trevelyan Square",
            "Boar Ln",
            "Leeds"
          ],
          "postalCode": "LS1 6AE"
        },
        "telecom": {
          "system": "phone",
          "value": "03003035678",
          "use": "work"
        },
        "managingOrganization": {
          "reference": "Organization/db67f447-b30d-442a-8e31-6918d1367eeb"
        }
      }
    },
    {
      "resource": {
        "resourceType": "List",
        "meta": {
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-List-1"
          ]
        },
        "status": "current",
        "mode": "snapshot",
        "title": "Diary",
        "code": {
          "coding": [
            {
              "code": "714311000000108",
              "display": "Patient recall administration",
              "system": "http://snomed.info/sct"
            }
          ]
        },
        "subject": {
          "reference": "Patient/04603d77-1a4e-4d63-b246-d7504f8bd833"
        },
        "date": "2019-03-01T10:57:34+00:00",
        "orderedBy": {
          "coding": [
            {
              "code": "event-date",
              "system": "http://hl7.org/fhir/list-order"
            }
          ]
        },
        "entry": [
          {
            "item": {
              "reference": "ProcedureRequest/eba25af1-5b74-4790-aa5a-2134fd27ad45"
            }
          },
          {
            "item": {
              "reference": "ProcedureRequest/eba25af1-5b74-4790-aa5a-2134fd57ad45"
            }
          }
        ]
      }
    },
    {
      "resourceType": "ProcedureRequest",
      "meta": {
        "profile": [
          "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1"
        ]
      },
      "id": "eba25af1-5b74-4790-aa5a-2134fd27ad45",
      "identifier": [
        {
          "system": "https://fhir.nhs.uk/Id/cross-care-setting-identifier",
          "value": "urn:uuid:eba25af1-5b74-4790-aa5a-2134fd27ad75"
        }
      ],
      "status": "active",
      "intent": "plan",
      "code": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "314529007",
            "display": "Medication review due"
          }
        ]
      },
      "subject": {
        "reference": "Patient/04603d77-1a4e-4d63-b246-d7504f8bd833"
      },
      "context": {
        "reference": "Encounter/Encounter1"
      },
      "occurrence": "2019-05-02",
      "authoredOn": "2019-03-02",
      "requester": {
        "agent": {
          "reference": "Practitioner/6c41ebfd-57c3-4162-9d7b-208c171a2fd7"
        }
      }
    },
    {
      "resourceType": "ProcedureRequest",
      "meta": {
        "profile": [
          "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1"
        ]
      },
      "id": "eba25af1-5b74-4790-aa5a-2134fd57ad45",
      "identifier": [
        {
          "system": "https://fhir.nhs.uk/Id/cross-care-setting-identifier",
          "value": "urn:uuid:eba25af1-5b74-4790-aa5a-2134fd27ad75"
        }
      ],
      "status": "active",
      "intent": "plan",
      "code": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "408490001",
            "display": "Antipsychotic drug therapy"
          }
        ]
      },
      "subject": {
        "reference": "Patient/04603d77-1a4e-4d63-b246-d7504f8bd833"
      },
      "context": {
        "reference": "Encounter/Encounter3"
      },
      "occurrence": {
        "start": "2019-05-01",
        "end": "2019-05-01"
      },
      "authoredOn": "2019-05-01",
      "requester": {
        "agent": {
          "reference": "Practitioner/6c41ebfd-57c3-4162-9d7b-208c171a2fd7"
        }
      }
    },
    {
        "resource": {
        "resourceType": "Condition",
        "id": "aba25af1-5b74-4790-aa5a-2134fd57ad45",
        "meta": {
            "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProblemHeader-Condition-1"
            ]
        },
        "clinicalStatus": "active",
        "code": {
            "coding":
            [
                {
                    "system": "http://snomed.info/sct",
                    "code": "449614009",
                    "display": "Swelling of lower limb (finding)",
                    "extension": [
                        {
                            "url": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid",
                            "extension": [
                                {
                                    "url": "DescriptionID",
                                    "valueId": "2729461000000110"
                                },
                                {
                                    "url": "descriptionDisplay",
                                    "valueString": "Swollen leg"
                                }
                                ]
                        }
                    ]
                }
            ],
            "text": "Swollen legs"
        },
        "subject": {
            "reference": "Patient/04603d77-1a4e-4d63-b246-d7504f8bd833"
        },
        "extension": [
        {
            "url": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-RelatedClinicalContent-1",
            "valueReference": {
                "reference": "ProcedureRequest/eba25af1-5b74-4790-aa5a-2134fd27ad45"
            }
        }
    	],
        "assertedDate": "2018-09-28T10:30:00",
        "onsetDateTime": "2019-03-28T10:30:00"
    }
    }
  ]
}

All content is available under the Open Government Licence v3.0, except where otherwise stated