GP Connect - Access Record Structured

Use case

Migrate a patient’s record from one organisation to another in FHIR® structured format.

API specification

See API specification for more details about topic such as:

• Who can use the API
• Related APIs
• API status and roadmap
• Service level
• Security and authorisation
• Environments and testing
• Onboarding
• Error handling

Interaction diagram

Payload response body

Provider systems MUST:

• return a 200 OK HTTP status code to indicate successful retrieval of a patient’s structured record
• return a Bundle conforming to the GPConnect-StructuredRecord-Bundle-1 profile definition
• return the following resources in the Bundle:
  • Patient matching the NHS Number sent in the body of the request
  • Organization matching the patient’s previously registered GP practice, where their record is being migrated from, referenced from Patient.generalPractitioner
  • Organization matching the organisation serving the request, if different from above, referenced from Patient.managingOrganization
  • Practitioner matching the patient’s usual GP, if they have one, referenced from Patient.generalPractitioner
  • PractitionerRole matching the usual GP’s role
  • resources holding consultations, problems, immunisations, allergies, intolerance, medications, uncategorised data, referrals, investigations and diary entries according to the rules below:

Provider systems SHOULD:

• provide a consistent order to elements within the Bundle resource. It is recommended to follow the order described in the Bundle population illustrated diagram.

Consumers systems MUST NOT:

• rely on order or index of elements within the Bundle resource in order to parse encapsulated resources.

Full record

Provider systems MUST include the following in the response Bundle:

• when the includeFullRecord parameter is not set:
  • no clinical information shall be returned
• when the includeFullRecord parameter is set:
  • A List resource for each clinical area referencing resources that have been returned
  • A List resource for secondary lists referencing resources contained in requested problems and consultations
  • MedicationStatement, MedicationRequest, Medication resources representing the patient’s medication
  • AllergyIntolerance resources representing the patient’s allergies and intolerances
  • List, Condition, Encounter, List - Consultation and Observation - narrative resources representing the patient’s consultations
  • Condition resources representing the patient’s problems
  • Immunization resources representing the patient’s immunisations
  • Observation - uncategorised resources representing the patient’s uncategorised data
  • DiagnosticReport, Observation - Test Group Header, Observation - Test Result, Observation - Filing Comments, ProcedureRequest, Specimen, DocumentReference resources representing the patient’s test results
  • ReferralRequest resources representing the patient’s referrals will be returned.
  • ProcedureRequest resources representing the patient’s diary entries will be returned.
  • DocumentReference resources representing the patient’s documents.
• and when the includeSensitiveInformation parameter is set to false:
  • only non confidential information will be returned
• and when the includeSensitiveInformation parameter is set to true:
  • confidential and sensitive information will be returned

Documents

DocumentReference resources containing document metadata including location will be returned as part of the response Bundle. Retrieval of these MUST be performed using the Migrate a document API in the Access Document capability.

Operation definition

See OperationDefintion: GPConnect-MigrateStructuredRecord-Operation.

Payload response examples

Given the response model is shared with GetStructuredRecord, the same examples are applicable:

• Allergy examples
• Medication examples
• Consultation examples
• Problem examples
• Immunisation examples
• Uncategorised data examples
• Investigation examples
• Referral examples
• Diary entry examples