GPConnect-MigrateStructuredRecord-Operation-1

HTML View

Invocations

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

Parameters (In)

NameCardinalityTypeDocumentation
patientNHSNumber1..1Identifier

NHS Number of the patient for whom to retrieve the structured record.

includeFullRecord1..1

Include the patient's full clinical record in the response.

includeFullRecord.includeSensitiveInformation1..1Boolean

Include confidential and sensitive information in the response, this parameter has a default value of 'true'. This parameter can only be set to true if an appropriate requested_scope value is provided in the JWT, more guidance is available in the Cross-organisation audit and provenance page. Part parameter: may only be provided if includeFullRecord is set.

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-MigrateStructuredRecord-Operation-1
OperationDefinition.url[0]https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-MigrateStructuredRecord-Operation-1
OperationDefinition.version[0]1.0.0
OperationDefinition.name[0]GPConnect-MigrateStructuredRecord-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.code[0]gpc.migratestructuredrecord
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]NHS Number of the patient for whom to retrieve the structured record.
OperationDefinition.parameter[0].type[0]Identifier
OperationDefinition.parameter[1].name[0]includeFullRecord
OperationDefinition.parameter[1].use[0]in
OperationDefinition.parameter[1].min[0]1
OperationDefinition.parameter[1].max[0]1
OperationDefinition.parameter[1].documentation[0]Include the patient's full clinical record in the response.
OperationDefinition.parameter[1].part[0].name[0]includeSensitiveInformation
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 confidential and sensitive information in the response, this parameter has a default value of 'true'. This parameter can only be set to true if an appropriate `requested_scope` value is provided in the JWT, more guidance is available in the Cross-organisation audit and provenance page. Part parameter: may only be provided if includeFullRecord is set.
OperationDefinition.parameter[1].part[0].type[0]boolean
OperationDefinition.parameter[2].name[0]response
OperationDefinition.parameter[2].use[0]out
OperationDefinition.parameter[2].min[0]1
OperationDefinition.parameter[2].max[0]1
OperationDefinition.parameter[2].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[2].type[0]Bundle
OperationDefinition.parameter[2].profile[0].reference[0]https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1

XML View

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="GPConnect-MigrateStructuredRecord-Operation-1" />
<url value="https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-MigrateStructuredRecord-Operation-1" />
<version value="1.0.0" />
<name value="GPConnect-MigrateStructuredRecord-Operation" />
<status value="active" />
<kind value="operation" />
<date value="2023-12-06" />
<publisher value="NHS England" />
<contact>
<name value="Interoperability Team" />
<telecom>
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
</telecom>
</contact>
<code value="gpc.migratestructuredrecord" />
<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="NHS Number of the patient for whom to retrieve the structured record." />
<type value="Identifier" />
</parameter>
<parameter>
<name value="includeFullRecord" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Include the patient's full clinical record in the response." />
<part>
<name value="includeSensitiveInformation" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Include confidential and sensitive information in the response, this parameter has a default value of 'true'. This parameter can only be set to true if an appropriate `requested_scope` value is provided in the JWT, more guidance is available in the Cross-organisation audit and provenance page. Part parameter: may only be provided if includeFullRecord is set." />
<type value="boolean" />
</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.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1" />
</profile>
</parameter>
</OperationDefinition>

JSON View

{
"resourceType": "OperationDefinition",
"id": "GPConnect-MigrateStructuredRecord-Operation-1",
"url": "https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-MigrateStructuredRecord-Operation-1",
"version": "1.0.0",
"name": "GPConnect-MigrateStructuredRecord-Operation",
"status": "active",
"kind": "operation",
"date": "2023-12-06",
"publisher": "NHS England",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net"
}
]
}
],
"code": "gpc.migratestructuredrecord",
"resource": [
"Patient"
],
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "patientNHSNumber",
"use": "in",
"min": 1,
"max": "1",
"documentation": "NHS Number of the patient for whom to retrieve the structured record.",
"type": "Identifier"
},
{
"name": "includeFullRecord",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Include the patient's full clinical record in the response.",
"part": [
{
"name": "includeSensitiveInformation",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Include confidential and sensitive information in the response, this parameter has a default value of 'true'. This parameter can only be set to true if an appropriate `requested_scope` value is provided in the JWT, more guidance is available in the Cross-organisation audit and provenance page. Part parameter: may only be provided if includeFullRecord is set.",
"type": "boolean"
}
]
},
{
"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"
}
}
]
}
---
back to top