| Package | uk.nhsdigital.r4.test |
| Resource Type | OperationDefinition |
| Id | Task-release-message |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=uk.nhsdigital.r4.test@2.17.0-prerelease&canonical=https://fhir.nhs.uk/OperationDefinition/Task-release-message |
| URL | https://fhir.nhs.uk/OperationDefinition/Task-release-message |
| Version | 4.0.1 |
| Status | draft |
| Date | 2020-11-13T09:29:23+11:00 |
| Name | ReleaseTask |
| Description | Use this endpoint to download prescriptions from Spine before it is dispensed. You can download a single prescription using the prescription's ID, or download up to 25 prescriptions (per request) nominated to a dispenser using the dispenser's ODS code. |
| Type | true |
| Kind | operation |
| CapabilityStatement | |
| apim-eps-nextgen | APIMEPSNextGen |
| apim-medicines-api-example | APIMEPS |
No resources found
No narrative content found in resource
{
"resourceType": "OperationDefinition",
"id": "Task-release-message",
"meta": {
"lastUpdated": "2019-11-01T09:29:23.356+11:00"
},
"url": "https://fhir.nhs.uk/OperationDefinition/Task-release-message",
"version": "4.0.1",
"name": "ReleaseTask",
"status": "draft",
"kind": "operation",
"date": "2020-11-13T09:29:23+11:00",
"publisher": "NHS Digital",
"contact": [
{
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net"
}
]
}
],
"description": "Use this endpoint to download prescriptions from Spine before it is dispensed. You can download a single prescription using the prescription's ID, or download up to 25 prescriptions (per request) nominated to a dispenser using the dispenser's ODS code.",
"affectsState": true,
"code": "release",
"comment": "Only one of the parameters group-identifier and owner MUST be provided. This operation performs both a query on the message queue and updates the status of returned prescriptions.",
"resource": [
"Task"
],
"system": false,
"type": true,
"instance": false,
"outputProfile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Bundle-SearchSet",
"parameter": [
{
"name": "group-identifier",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The short-form-prescription-id (token) of the prescription. Used for releasing Patient prescriptions",
"type": "Identifier"
},
{
"name": "owner",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The organization (pharmacy) downloading the prescriptions. Used for releasing Nominated Pharmacy prescriptions",
"type": "Organization"
},
{
"name": "status",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Status from ValueSet http://hl7.org/fhir/valueset-task-status.html Use: accepted",
"type": "code"
},
{
"name": "agent",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The professional submitting the release request",
"type": "PractitionerRole"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "A FHIR Bundle (type=searchset) which contains prescription-order FHIR Messages which match the search parameters. An empty search will still return a FHIR Bundle but with no entries.",
"type": "Bundle"
}
]
}