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.
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="GPConnect-GetStructuredRecord-Operation-1"></id>
<text>
<status value="generated"></status>
</text>
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1"></url>
<version value="1.17.0"></version>
<name value="GPConnect-GetStructuredRecord-Operation"></name>
<status value="draft"></status>
<kind value="operation"></kind>
<date value="2020-11-19"></date>
<publisher value="NHS Digital"></publisher>
<contact>
<name value="Interoperability Team"></name>
<telecom>
<system value="email"></system>
<value value="interoperabilityteam@nhs.net"></value>
</telecom>
</contact>
<description value="Get a patient's clinical record in a structured coded format."></description>
<code value="gpc.getstructuredrecord"></code>
<resource value="Patient"></resource>
<system value="false"></system>
<type value="true"></type>
<instance value="false"></instance>
<parameter>
<name value="patientNHSNumber"></name>
<use value="in"></use>
<min value="1"></min>
<max value="1"></max>
<documentation value="The NHS number of the patient whose record is being extracted, which must be traced or verified against the national demographics index."></documentation>
<type value="Identifier"></type>
</parameter>
<parameter>
<name value="includeAllergies"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include resources representing a patient's allergies and intolerances in the response bundle. By default, resolved allergies and intolerances are not included."></documentation>
<part>
<name value="includeResolvedAllergies"></name>
<use value="in"></use>
<min value="1"></min>
<max value="1"></max>
<documentation value="Include resolved allergies and intolerances in the response bundle."></documentation>
<type value="boolean"></type>
</part>
</parameter>
<parameter>
<name value="includeMedication"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include resources representing a patient's medication record in the response bundle."></documentation>
<part>
<name value="includePrescriptionIssues"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include each prescription issue in the response. By default, prescription issues are not included."></documentation>
<type value="boolean"></type>
</part>
<part>
<name value="medicationSearchFromDate"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict the patient's medication record to those that are active on or after medicationSearchFromDate."></documentation>
<type value="date"></type>
</part>
</parameter>
<parameter>
<name value="response"></name>
<use value="out"></use>
<min value="1"></min>
<max value="1"></max>
<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."></documentation>
<type value="Bundle"></type>
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1"></reference>
</profile>
</parameter>
<parameter>
<name value="includeConsultations"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include consultations in the response."></documentation>
<part>
<name value="consultationSearchPeriod"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict consultations by defining a time period."></documentation>
<type value="Period"></type>
</part>
<part>
<name value="includeNumberOfMostRecent"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Limit the number of returned consultations."></documentation>
<type value="positiveInt"></type>
</part>
</parameter>
<parameter>
<name value="includeProblems"></name>
<use value="in"></use>
<min value="0"></min>
<max value="*"></max>
<documentation value="Include problems in the response."></documentation>
<part>
<name value="filterStatus"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict the problems that are returned by their clinical status."></documentation>
<type value="code"></type>
<binding>
<strength value="required"></strength>
<valueSetUri value="http://hl7.org/fhir/ValueSet/condition-clinical"></valueSetUri>
</binding>
</part>
<part>
<name value="filterSignificance"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict the problems that are returned by their clinical significance."></documentation>
<type value="code"></type>
<binding>
<strength value="required"></strength>
<valueSetUri value="https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ProblemSignificance-1"></valueSetUri>
</binding>
</part>
</parameter>
<parameter>
<name value="includeImmunisations"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include immunisations in the response."></documentation>
<part>
<name value="includeNotGiven"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include immunisations not given in the response."></documentation>
<type value="boolean"></type>
</part>
<part>
<name value="includeStatus"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include information about the status for immunisations in the response."></documentation>
<type value="boolean"></type>
</part>
</parameter>
<parameter>
<name value="includeUncategorisedData"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include uncategorised data in the response."></documentation>
<part>
<name value="uncategorisedDataSearchPeriod"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict uncategorised data by defining a time period."></documentation>
<type value="Period"></type>
</part>
</parameter>
<parameter>
<name value="includeDiaryEntries"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include diary entries in the response."></documentation>
<part>
<name value="diaryEntriesSearchDate"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include diary entries prior to the the diaryEntriesSearchDate."></documentation>
<type value="date"></type>
</part>
</parameter>
<parameter>
<name value="includeInvestigations"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include investigations in the response."></documentation>
<part>
<name value="investigationSearchPeriod"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict the investigations that are returned by defining a time period."></documentation>
<type value="Period"></type>
</part>
</parameter>
<parameter>
<name value="includeReferrals"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Include referrals in the response."></documentation>
<part>
<name value="referralSearchPeriod"></name>
<use value="in"></use>
<min value="0"></min>
<max value="1"></max>
<documentation value="Restrict uncategorised data by defining a time period."></documentation>
<type value="Period"></type>
</part>
</parameter>
</OperationDefinition>