GPConnect-GetStructuredRecord-Operation-1

HTML View

Invocations

URL: [base]/Patient/$gpc.getstructuredrecord

Parameters (In)

NameCardinalityTypeBindingDocumentation
patientNHSNumber1..1Identifier

The NHS number of the patient whose record is being extracted, which must be traced or verified against the national demographics index.

includeAllergies0..1

Include resources representing a patient's allergies and intolerances in the response bundle. By default, resolved allergies and intolerances are not included.

includeAllergies.includeResolvedAllergies1..1Boolean

Include resolved allergies and intolerances in the response bundle.

includeMedication0..1

Include resources representing a patient's medication record in the response bundle.

includeMedication.includePrescriptionIssues0..1Boolean

Include each prescription issue in the response. By default, prescription issues are not included.

includeMedication.medicationSearchFromDate0..1Date

Restrict the patient's medication record to those that are active on or after medicationSearchFromDate.

includeMedication.filterPrescriptionType0..*CodeCare Connect Prescription Type (required)

Filter the patient's medication records returned according to the specified prescription type(s) for the medicationRequests. Any medicationRequest resources with no prescriptionType code will be included against requests for an acute prescription type.

includeConsultations0..1

Include consultations in the response.

includeConsultations.consultationSearchPeriod0..1Period

Restrict consultations by defining a time period.

includeConsultations.includeNumberOfMostRecent0..1PositiveInt

Limit the number of returned consultations.

includeProblems0..1

Include problems in the response.

includeProblems.filterStatus0..1CodeCondition Clinical Status Codes (required)

Restrict the problems that are returned by their clinical status.

includeImmunisations0..1

Include immunisations in the response.

includeImmunisations.includeNotGiven0..1Boolean

Include immunisations not given in the response.

includeImmunisations.includeStatus0..1Boolean

Include information about the status for immunisations in the response.

includeUncategorisedData0..1

Include uncategorised data in the response.

includeUncategorisedData.uncategorisedDataSearchPeriod0..1Period

Restrict uncategorised data by defining a time period.

includeDiaryEntries0..1

Include diary entries in the response.

includeDiaryEntries.diaryEntriesSearchDate0..1Date

Include diary entries prior to the the diaryEntriesSearchDate.

includeInvestigations0..1

Include investigations in the response.

includeInvestigations.investigationSearchPeriod0..1Period

Restrict the investigations that are returned by defining a time period.

includeReferrals0..1

Include referrals in the response.

includeReferrals.referralSearchPeriod0..1Period

Restrict uncategorised data by defining a time period.

Return Values (Out)

NameCardinalityTypeStructureDefinitionDocumentation
response1..1BundleGPConnect-StructuredRecord-Bundle-1

The patient structured coded record. This is returned as a bundle containing resources representing the record as requested by the given input parameters.

Table View

OperationDefinition.id[0]GPConnect-GetStructuredRecord-Operation-1
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1
OperationDefinition.version[0]1.19.0
OperationDefinition.name[0]GPConnect-GetStructuredRecord-Operation
OperationDefinition.status[0]active
OperationDefinition.kind[0]operation
OperationDefinition.date[0]2023-12-06
OperationDefinition.publisher[0]NHS England
OperationDefinition.contact[0].name[0]Interoperability Team
OperationDefinition.contact[0].telecom[0].system[0]email
OperationDefinition.contact[0].telecom[0].value[0]interoperabilityteam@nhs.net
OperationDefinition.description[0]Get a patient's clinical record in a structured coded format.
OperationDefinition.code[0]gpc.getstructuredrecord
OperationDefinition.resource[0]Patient
OperationDefinition.system[0]False
OperationDefinition.type[0]True
OperationDefinition.instance[0]False
OperationDefinition.parameter[0].name[0]patientNHSNumber
OperationDefinition.parameter[0].use[0]in
OperationDefinition.parameter[0].min[0]1
OperationDefinition.parameter[0].max[0]1
OperationDefinition.parameter[0].documentation[0]The NHS number of the patient whose record is being extracted, which must be traced or verified against the national demographics index.
OperationDefinition.parameter[0].type[0]Identifier
OperationDefinition.parameter[1].name[0]includeAllergies
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]0
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]Include resources representing a patient's allergies and intolerances in the response bundle. By default, resolved allergies and intolerances are not included.
OperationDefinition.parameter[1].part[0].name[0]includeResolvedAllergies
OperationDefinition.parameter[1].part[0].use[0]in
OperationDefinition.parameter[1].part[0].min[0]1
OperationDefinition.parameter[1].part[0].max[0]1
OperationDefinition.parameter[1].part[0].documentation[0]Include resolved allergies and intolerances in the response bundle.
OperationDefinition.parameter[1].part[0].type[0]boolean
OperationDefinition.parameter[2].name[0]includeMedication
OperationDefinition.parameter[2].use[0]in
OperationDefinition.parameter[2].min[0]0
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].documentation[0]Include resources representing a patient's medication record in the response bundle.
OperationDefinition.parameter[2].part[0].name[0]includePrescriptionIssues
OperationDefinition.parameter[2].part[0].use[0]in
OperationDefinition.parameter[2].part[0].min[0]0
OperationDefinition.parameter[2].part[0].max[0]1
OperationDefinition.parameter[2].part[0].documentation[0]Include each prescription issue in the response. By default, prescription issues are not included.
OperationDefinition.parameter[2].part[0].type[0]boolean
OperationDefinition.parameter[2].part[1].name[0]medicationSearchFromDate
OperationDefinition.parameter[2].part[1].use[0]in
OperationDefinition.parameter[2].part[1].min[0]0
OperationDefinition.parameter[2].part[1].max[0]1
OperationDefinition.parameter[2].part[1].documentation[0]Restrict the patient's medication record to those that are active on or after medicationSearchFromDate.
OperationDefinition.parameter[2].part[1].type[0]date
OperationDefinition.parameter[2].part[2].name[0]filterPrescriptionType
OperationDefinition.parameter[2].part[2].use[0]in
OperationDefinition.parameter[2].part[2].min[0]0
OperationDefinition.parameter[2].part[2].max[0]*
OperationDefinition.parameter[2].part[2].documentation[0]Filter the patient's medication records returned according to the specified prescription type(s) for the medicationRequests. Any medicationRequest resources with no prescriptionType code will be included against requests for an acute prescription type.
OperationDefinition.parameter[2].part[2].type[0]code
OperationDefinition.parameter[2].part[2].binding[0].strength[0]required
OperationDefinition.parameter[2].part[2].binding[0].valueSet[0]https://fhir.nhs.uk/STU3/ValueSet/CareConnect-PrescriptionType-1
OperationDefinition.parameter[3].name[0]response
OperationDefinition.parameter[3].use[0]out
OperationDefinition.parameter[3].min[0]1
OperationDefinition.parameter[3].max[0]1
OperationDefinition.parameter[3].documentation[0]The patient structured coded record. This is returned as a bundle containing resources representing the record as requested by the given input parameters.
OperationDefinition.parameter[3].type[0]Bundle
OperationDefinition.parameter[3].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1
OperationDefinition.parameter[4].name[0]includeConsultations
OperationDefinition.parameter[4].use[0]in
OperationDefinition.parameter[4].min[0]0
OperationDefinition.parameter[4].max[0]1
OperationDefinition.parameter[4].documentation[0]Include consultations in the response.
OperationDefinition.parameter[4].part[0].name[0]consultationSearchPeriod
OperationDefinition.parameter[4].part[0].use[0]in
OperationDefinition.parameter[4].part[0].min[0]0
OperationDefinition.parameter[4].part[0].max[0]1
OperationDefinition.parameter[4].part[0].documentation[0]Restrict consultations by defining a time period.
OperationDefinition.parameter[4].part[0].type[0]Period
OperationDefinition.parameter[4].part[1].name[0]includeNumberOfMostRecent
OperationDefinition.parameter[4].part[1].use[0]in
OperationDefinition.parameter[4].part[1].min[0]0
OperationDefinition.parameter[4].part[1].max[0]1
OperationDefinition.parameter[4].part[1].documentation[0]Limit the number of returned consultations.
OperationDefinition.parameter[4].part[1].type[0]positiveInt
OperationDefinition.parameter[5].name[0]includeProblems
OperationDefinition.parameter[5].use[0]in
OperationDefinition.parameter[5].min[0]0
OperationDefinition.parameter[5].max[0]1
OperationDefinition.parameter[5].documentation[0]Include problems in the response.
OperationDefinition.parameter[5].part[0].name[0]filterStatus
OperationDefinition.parameter[5].part[0].use[0]in
OperationDefinition.parameter[5].part[0].min[0]0
OperationDefinition.parameter[5].part[0].max[0]1
OperationDefinition.parameter[5].part[0].documentation[0]Restrict the problems that are returned by their clinical status.
OperationDefinition.parameter[5].part[0].type[0]code
OperationDefinition.parameter[5].part[0].binding[0].strength[0]required
OperationDefinition.parameter[5].part[0].binding[0].valueSet[0]http://hl7.org/fhir/ValueSet/condition-clinical
OperationDefinition.parameter[6].name[0]includeImmunisations
OperationDefinition.parameter[6].use[0]in
OperationDefinition.parameter[6].min[0]0
OperationDefinition.parameter[6].max[0]1
OperationDefinition.parameter[6].documentation[0]Include immunisations in the response.
OperationDefinition.parameter[6].part[0].name[0]includeNotGiven
OperationDefinition.parameter[6].part[0].use[0]in
OperationDefinition.parameter[6].part[0].min[0]0
OperationDefinition.parameter[6].part[0].max[0]1
OperationDefinition.parameter[6].part[0].documentation[0]Include immunisations not given in the response.
OperationDefinition.parameter[6].part[0].type[0]boolean
OperationDefinition.parameter[6].part[1].name[0]includeStatus
OperationDefinition.parameter[6].part[1].use[0]in
OperationDefinition.parameter[6].part[1].min[0]0
OperationDefinition.parameter[6].part[1].max[0]1
OperationDefinition.parameter[6].part[1].documentation[0]Include information about the status for immunisations in the response.
OperationDefinition.parameter[6].part[1].type[0]boolean
OperationDefinition.parameter[7].name[0]includeUncategorisedData
OperationDefinition.parameter[7].use[0]in
OperationDefinition.parameter[7].min[0]0
OperationDefinition.parameter[7].max[0]1
OperationDefinition.parameter[7].documentation[0]Include uncategorised data in the response.
OperationDefinition.parameter[7].part[0].name[0]uncategorisedDataSearchPeriod
OperationDefinition.parameter[7].part[0].use[0]in
OperationDefinition.parameter[7].part[0].min[0]0
OperationDefinition.parameter[7].part[0].max[0]1
OperationDefinition.parameter[7].part[0].documentation[0]Restrict uncategorised data by defining a time period.
OperationDefinition.parameter[7].part[0].type[0]Period
OperationDefinition.parameter[8].name[0]includeDiaryEntries
OperationDefinition.parameter[8].use[0]in
OperationDefinition.parameter[8].min[0]0
OperationDefinition.parameter[8].max[0]1
OperationDefinition.parameter[8].documentation[0]Include diary entries in the response.
OperationDefinition.parameter[8].part[0].name[0]diaryEntriesSearchDate
OperationDefinition.parameter[8].part[0].use[0]in
OperationDefinition.parameter[8].part[0].min[0]0
OperationDefinition.parameter[8].part[0].max[0]1
OperationDefinition.parameter[8].part[0].documentation[0]Include diary entries prior to the the diaryEntriesSearchDate.
OperationDefinition.parameter[8].part[0].type[0]date
OperationDefinition.parameter[9].name[0]includeInvestigations
OperationDefinition.parameter[9].use[0]in
OperationDefinition.parameter[9].min[0]0
OperationDefinition.parameter[9].max[0]1
OperationDefinition.parameter[9].documentation[0]Include investigations in the response.
OperationDefinition.parameter[9].part[0].name[0]investigationSearchPeriod
OperationDefinition.parameter[9].part[0].use[0]in
OperationDefinition.parameter[9].part[0].min[0]0
OperationDefinition.parameter[9].part[0].max[0]1
OperationDefinition.parameter[9].part[0].documentation[0]Restrict the investigations that are returned by defining a time period.
OperationDefinition.parameter[9].part[0].type[0]Period
OperationDefinition.parameter[10].name[0]includeReferrals
OperationDefinition.parameter[10].use[0]in
OperationDefinition.parameter[10].min[0]0
OperationDefinition.parameter[10].max[0]1
OperationDefinition.parameter[10].documentation[0]Include referrals in the response.
OperationDefinition.parameter[10].part[0].name[0]referralSearchPeriod
OperationDefinition.parameter[10].part[0].use[0]in
OperationDefinition.parameter[10].part[0].min[0]0
OperationDefinition.parameter[10].part[0].max[0]1
OperationDefinition.parameter[10].part[0].documentation[0]Restrict uncategorised data by defining a time period.
OperationDefinition.parameter[10].part[0].type[0]Period

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="GPConnect-GetStructuredRecord-Operation-1" />
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1" />
<version value="1.19.0" />
<name value="GPConnect-GetStructuredRecord-Operation" />
<status value="active" />
<kind value="operation" />
<date value="2023-12-06" />
<publisher value="NHS England" />
<name value="Interoperability Team" />
<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" />
<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>
<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." />
<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>
<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." />
<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>
<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>
<name value="filterPrescriptionType" />
<use value="in" />
<min value="0" />
<max value="*" />
<documentation value="Filter the patient's medication records returned according to the specified prescription type(s) for the medicationRequests. Any medicationRequest resources with no prescriptionType code will be included against requests for an acute prescription type." />
<type value="code" />
<strength value="required" />
<valueSetUri value="https://fhir.nhs.uk/STU3/ValueSet/CareConnect-PrescriptionType-1" />
</binding>
</part>
</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" />
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1" />
</profile>
</parameter>
<name value="includeConsultations" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include consultations in the response." />
<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>
<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>
<name value="includeProblems" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include problems in the response." />
<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" />
<strength value="required" />
<valueSetUri value="http://hl7.org/fhir/ValueSet/condition-clinical" />
</binding>
</part>
</parameter>
<name value="includeImmunisations" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include immunisations in the response." />
<name value="includeNotGiven" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include immunisations not given in the response." />
<type value="boolean" />
</part>
<name value="includeStatus" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include information about the status for immunisations in the response." />
<type value="boolean" />
</part>
</parameter>
<name value="includeUncategorisedData" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include uncategorised data in the response." />
<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>
<name value="includeDiaryEntries" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include diary entries in the response." />
<name value="diaryEntriesSearchDate" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include diary entries prior to the the diaryEntriesSearchDate." />
<type value="date" />
</part>
</parameter>
<name value="includeInvestigations" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include investigations in the response." />
<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>
<name value="includeReferrals" />
<use value="in" />
<min value="0" />
<max value="1" />
<documentation value="Include referrals in the response." />
<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>

JSON View

{
"resourceType": "OperationDefinition",
"id": "GPConnect-GetStructuredRecord-Operation-1",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-GetStructuredRecord-Operation-1",
"version": "1.19.0",
"name": "GPConnect-GetStructuredRecord-Operation",
"status": "active",
"kind": "operation",
"date": "2023-12-06",
"publisher": "NHS England",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net"
}
]
}
],
"description": "Get a patient's clinical record in a structured coded format.",
"code": "gpc.getstructuredrecord",
"Patient"
],
"system": false,
"type": true,
"instance": false,
{
"name": "patientNHSNumber",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The NHS number of the patient whose record is being extracted, which must be traced or verified against the national demographics index.",
"type": "Identifier"
},
{
"name": "includeAllergies",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include resources representing a patient's allergies and intolerances in the response bundle. By default, resolved allergies and intolerances are not included.",
"part": [
{
"name": "includeResolvedAllergies",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Include resolved allergies and intolerances in the response bundle.",
"type": "boolean"
}
]
},
{
"name": "includeMedication",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include resources representing a patient's medication record in the response bundle.",
"part": [
{
"name": "includePrescriptionIssues",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include each prescription issue in the response. By default, prescription issues are not included.",
"type": "boolean"
},
{
"name": "medicationSearchFromDate",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Restrict the patient's medication record to those that are active on or after medicationSearchFromDate.",
"type": "date"
},
{
"name": "filterPrescriptionType",
"use": "in",
"min": 0,
"max": "*",
"documentation": "Filter the patient's medication records returned according to the specified prescription type(s) for the medicationRequests. Any medicationRequest resources with no prescriptionType code will be included against requests for an acute prescription type.",
"type": "code",
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nhs.uk/STU3/ValueSet/CareConnect-PrescriptionType-1"
}
}
]
},
{
"name": "response",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The patient structured coded record. This is returned as a bundle containing resources representing the record as requested by the given input parameters.",
"type": "Bundle",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1"
}
},
{
"name": "includeConsultations",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include consultations in the response.",
"part": [
{
"name": "consultationSearchPeriod",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Restrict consultations by defining a time period.",
"type": "Period"
},
{
"name": "includeNumberOfMostRecent",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Limit the number of returned consultations.",
"type": "positiveInt"
}
]
},
{
"name": "includeProblems",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include problems in the response.",
"part": [
{
"name": "filterStatus",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Restrict the problems that are returned by their clinical status.",
"type": "code",
"binding": {
"strength": "required",
"valueSetUri": "http://hl7.org/fhir/ValueSet/condition-clinical"
}
}
]
},
{
"name": "includeImmunisations",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include immunisations in the response.",
"part": [
{
"name": "includeNotGiven",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include immunisations not given in the response.",
"type": "boolean"
},
{
"name": "includeStatus",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include information about the status for immunisations in the response.",
"type": "boolean"
}
]
},
{
"name": "includeUncategorisedData",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include uncategorised data in the response.",
"part": [
{
"name": "uncategorisedDataSearchPeriod",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Restrict uncategorised data by defining a time period.",
"type": "Period"
}
]
},
{
"name": "includeDiaryEntries",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include diary entries in the response.",
"part": [
{
"name": "diaryEntriesSearchDate",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include diary entries prior to the the diaryEntriesSearchDate.",
"type": "date"
}
]
},
{
"name": "includeInvestigations",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include investigations in the response.",
"part": [
{
"name": "investigationSearchPeriod",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Restrict the investigations that are returned by defining a time period.",
"type": "Period"
}
]
},
{
"name": "includeReferrals",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Include referrals in the response.",
"part": [
{
"name": "referralSearchPeriod",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Restrict uncategorised data by defining a time period.",
"type": "Period"
}
]
}
]
}
---
back to top