release
Release (download) a prescription by a dispensing system.
| Name | Url |
|---|---|
| Task-release | https://fhir.nhs.uk/OperationDefinition/Task-release-message |
Invocations
URL: [base]/Task/$release
This operation changes content
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| group-identifier | 0..1 | Identifier | The short-form-prescription-id (token) of the prescription. Used for releasing Patient prescriptions |
| owner | 1..1 | Organization | The organization (pharmacy) downloading the prescriptions. Used for releasing Nominated Pharmacy prescriptions |
| status | 1..1 | code | Status from ValueSet http://hl7.org/fhir/valueset-task-status.html Use: accepted |
| agent | 1..1 | PractitionerRole | The professional submitting the release request |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| return | 1..1 | Bundle | 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. |
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.
Input Parameters
group-identifier
The group-identifier (also known as the prescription short form id) is used to download a single prescription. Omit when requesting nominated prescriptions for the dispensing site.
{
"name": "group-identifier",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/prescription-order-number",
"value": "82D996-C81010-11DB12"
}
}
owner
The owner is an Organization resource representing the dispensing site downloading the prescription(s). A valid contact telephone number must be provided as this is made visible to the prescribing system if a request to cancel the prescription is unsuccessful due to being downloaded by the dispenser.
{
"name": "owner",
"resource": {
"resourceType": "Organization",
"id": "organization",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "VNE51"
}
],
"address": [
{
"city": "West Yorkshire",
"use": "work",
"line": [
"17 Austhorpe Road",
"Crossgates",
"Leeds"
],
"postalCode": "LS15 8BA"
}
],
"active": true,
"type": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/organisation-role",
"code": "182",
"display": "PHARMACY"
}
]
}
],
"name": "The Simple Pharmacy",
"telecom": [
{
"system": "phone",
"use": "work",
"value": "0113 3180277"
}
]
}
}
status
The status is a fixed value of accepted.
{
"name": "status",
"valueCode": "accepted"
}
agent
The agent must be a PractitionerRole resource, representing the end user triggering the release request. The Role Profile ID, User ID and Job Role Code are available from the CIS2 authenticated session.
{
"name": "agent",
"resource": {
"resourceType": "PractitionerRole",
"id": "16708936-6397-4e03-b84f-4aaa790633e0",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
"value": "555086415105"
}
],
"practitioner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "3415870201"
},
"display": "Jackie Clark"
},
"code": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode",
"code": "S0030:G0100:R0620"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "02380798431",
"use": "work"
}
]
}
}