OperationDefinition: GPConnect-MigrateStructuredRecord-Operation
Invocations
URL: [base]/Patient/$gpc.migratestructuredrecord
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| patientNHSNumber | 1..1 | Identifier | NHS Number of the patient for whom to retrieve the structured record. |
| includeFullRecord | 1..1 | Include the patient's full clinical record in the response. | |
| includeFullRecord.includeSensitiveInformation | 1..1 | Boolean | 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 |
Return Values (Out)
| Name | Cardinality | Type | StructureDefinition | Documentation |
|---|---|---|---|---|
| response | 1..1 | Bundle | GPConnect-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. |
Resource population details
The Parameters resource is populated with the parameters shown below. Note: The ↳ character indicates a part parameter.
| Name | Type | Optionality | Cardinality | Comments |
|---|---|---|---|---|
patientNHSNumber |
Identifier |
Mandatory | 1..1 | NHS Number of the patient for whom to retrieve the structured record. |
includeFullRecord |
Mandatory | 1..1 | Include the patient's full clinical record in the response. | |
↳ includeSensitiveInformation |
Boolean |
Mandatory | 1..1 | 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 pagePart parameter: may only be provided if includeFullRecord is set. |
Examples
See Migrate examples for examples of how to populate the request.