API Hub

Explore and Make use of Nationally Defined Messaging APIs

This is a HL7 FHIR server, and as you appear to be accessing this page from a web browser you are seeing a HTML version of the requested resource(s). You can also access this URL from a FHIR client as a ReSTful API call. For more details please see the HL7 FHIR specification.
<?xml version="1.0" encoding="UTF-8" standalone="no"?><OperationDefinition xmlns="http://hl7.org/fhir">
   <id value="GPConnect-GetStructuredRecord-Operation-1"/>
   <url value="https://fhir-test.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1"/>
   <version value="1.13.0"/>
   <name value="GPConnect-GetStructuredRecord-Operation"/>
   <status value="draft"/>
   <kind value="operation"/>
   <date value="2019-11-22"/>
   <publisher value="NHS Digital"/>
   <contact>
      <name value="Interoperability Team"/>
      <telecom>
         <system value="email"/>
         <value value="interoperabilityteam@nhs.net"/>
      </telecom>
   </contact>
   <description value="Get a patient's clinical record in a structured coded format."/>
   <code value="gpc.getstructuredrecord"/>
   <resource value="Patient"/>
   <system value="false"/>
   <type value="true"/>
   <instance value="false"/>
   <parameter>
      <name value="patientNHSNumber"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The NHS number of the patient whose record is being extracted, which must be traced or verified against the national demographics index."/>
      <type value="Identifier"/>
   </parameter>
   <parameter>
      <name value="includeAllergies"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include resources representing a patient's allergies and intolerances in the response bundle. By default, resolved allergies and intolerances are not included."/>
      <part>
         <name value="includeResolvedAllergies"/>
         <use value="in"/>
         <min value="1"/>
         <max value="1"/>
         <documentation value="Include resolved allergies and intolerances in the response bundle."/>
         <type value="boolean"/>
      </part>
   </parameter>
   <parameter>
      <name value="includeMedication"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include resources representing a patient's medication record in the response bundle."/>
      <part>
         <name value="includePrescriptionIssues"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Include each prescription issue in the response. By default, prescription issues are not included."/>
         <type value="boolean"/>
      </part>
      <part>
         <name value="medicationSearchFromDate"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict the patient's medication record to those that are active on or after medicationSearchFromDate."/>
         <type value="date"/>
      </part>
   </parameter>
   <parameter>
      <name value="response"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The patient structured coded record. This is returned as a bundle containing resources representing the record as requested by the given input parameters."/>
      <type value="Bundle"/>
      <profile>
         <reference value="https://fhir-test.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1"/>
      </profile>
   </parameter>
   <parameter>
      <name value="includeConsultations"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include consultations in the response."/>
      <part>
         <name value="consultationSearchPeriod"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict consultations by defining a time period"/>
         <type value="Period"/>
      </part>
      <part>
         <name value="includeNumberOfMostRecent"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Limit the number of returned consultations"/>
         <type value="positiveInt"/>
      </part>
   </parameter>
   <parameter>
      <name value="includeProblems"/>
      <use value="in"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="Include problems in the response."/>
      <part>
         <name value="filterStatus"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict the problems that are returned by their clinical status"/>
         <type value="code"/>
         <binding>
            <strength value="required"/>
            <valueSetUri value="http://hl7.org/fhir/ValueSet/condition-clinical"/>
         </binding>
      </part>
      <part>
         <name value="filterSignificance"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict the problems that are returned by their clinical significance"/>
         <type value="code"/>
         <binding>
            <strength value="required"/>
            <valueSetUri value="https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ProblemSignificance-1"/>
         </binding>
      </part>
   </parameter>
   <parameter>
      <name value="includeImmunisations"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include immunisations in the response"/>
   </parameter>
   <parameter>
      <name value="includeUncategorisedData"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include uncategorised data in the response."/>
      <part>
         <name value="uncategorisedDataSearchPeriod"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict uncategorised data by defining a time period"/>
         <type value="Period"/>
      </part>
   </parameter>
   <parameter>
      <name value="includeInvestigations"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include investigations in the response"/>
      <part>
         <name value="investigationSearchPeriod"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict the investigations that are returned by defining a time period"/>
         <type value="Period"/>
      </part>
   </parameter>
   <parameter>
      <name value="includeReferrals"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Include referrals in the response."/>
      <part>
         <name value="referralSearchPeriod"/>
         <use value="in"/>
         <min value="0"/>
         <max value="1"/>
         <documentation value="Restrict uncategorised data by defining a time period"/>
         <type value="Period"/>
      </part>
   </parameter>
</OperationDefinition>