NHS Digital FHIR Medicines

verify-signature

Name	Url
verify-signature	`https://fhir.nhs.uk/OperationDefinition/verify-signature`

Invocations

URL: [base]/$verify-signature

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
content	1..1	Bundle	The search Bundle retrieved from the $release operation

Return Values (Out)

Name	Cardinality	Type	Documentation
entryNumber	1..1	integer	Index to the Bundle.entry in the supplied FHIR Bundle

{

"resourceType": "OperationDefinition",
"id": "ee360b98-f807-4c5b-a16f-d72933aff9d1",
"url": "https://fhir.nhs.uk/OperationDefinition/verify-signature",
"version": "4.0.1",
"name": "VerifySignature",
"status": "draft",
"kind": "operation",
"date": "2022-02-17T09:29:23+11:00",
"publisher": "NHS Digital",
"contact": [
{
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net"
}
]
}
],
"description": "Use this endpoint to verify a prescription's signature to ensure that the signature is valid, and that it matches the prescription it is attached to. This endpoint is expected to be used immediately after downloading prescriptions. Send the response message from the release endpoint to this endpoint. The signatures on these prescriptions will be verified. \n The endpoint will return a set of (up to 25) verify responses associated with the bundle of prescriptions sent to the endpoint for verification.",
"code": "verify-signature",
"resource": [
"Task"
],
"affectsState": true,
"system": true,
"type": false,
"instance": false,
"parameter": [
{
"name": "content",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The search Bundle retrieved from the $release operation",
"type": "Bundle"
},
{
"name": "entryNumber",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Index to the Bundle.entry in the supplied FHIR Bundle",
"type": "integer",
"part": [
{
"name": "messageIdentifier",
"use": "out",
"min": 1,
"max": "1",
"documentation": "A reference to the Bundled prescription-order FHIR Bundle",
"type": "Reference"
},
{
"name": "result",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The result of the individual prescription-order signature verification",
"type": "OperationOutcome"
}
]
}
]

}

<id value="ee360b98-f807-4c5b-a16f-d72933aff9d1" />
<url value="https://fhir.nhs.uk/OperationDefinition/verify-signature" />
<version value="4.0.1" />
<name value="VerifySignature" />
<status value="draft" />
<kind value="operation" />
<date value="2022-02-17T09:29:23+11:00" />
<publisher value="NHS Digital" />
<contact>
<telecom>
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
</telecom>
</contact>
<description value="Use this endpoint to verify a prescription's signature to ensure that the signature is valid, and that it matches the prescription it is attached to. This endpoint is expected to be used immediately after downloading prescriptions. Send the response message from the release endpoint to this endpoint. The signatures on these prescriptions will be verified. \n The endpoint will return a set of (up to 25) verify responses associated with the bundle of prescriptions sent to the endpoint for verification." />
<affectsState value="true" />
<code value="verify-signature" />
<resource value="Task" />
<system value="true" />
<type value="false" />
<instance value="false" />
<parameter>
<name value="content" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="The search Bundle retrieved from the $release operation" />
<type value="Bundle" />
</parameter>
<parameter>
<name value="entryNumber" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="Index to the Bundle.entry in the supplied FHIR Bundle" />
<type value="integer" />
<part>
<name value="messageIdentifier" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="A reference to the Bundled prescription-order FHIR Bundle" />
<type value="Reference" />
</part>
<part>
<name value="result" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="The result of the individual prescription-order signature verification" />
<type value="OperationOutcome" />
</part>
</parameter>

</OperationDefinition>