NHS Digital FHIR Medicines (Retired - 2.1.14)

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

release

Name Url
Task-release https://fhir.nhs.uk/OperationDefinition/Task-release-message

Invocations

URL: [base]/Task/$release

Parameters (In)

NameCardinalityTypeDocumentation
group-identifier0..1Identifier

The short-form-prescription-id (token) of the prescription. Used for releasing Patient prescriptions

owner0..1Identifier

The ODS code of the pharmacy. Used for releasing Nominated Pharmacy prescriptions

status1..1code

Status from ValueSet http://hl7.org/fhir/valueset-task-status.html Use: accepted

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Bundle

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 based-on.identifier and owner MUST be provided. This operation performs both a query on the message queue and updates the status of returned prescriptions.

{
    "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": "release-task",
    "status": "draft",
    "kind": "operation",
    "date": "2020-11-13T09:29:23+11:00",
    "publisher": "NHS Digital",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net"
                }
            ]
        }
    ],
    "description": "TODO - Add description",
    "code": "release",
    "comment": "Only one of the parameters based-on.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,
    "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": 0,
            "max": "1",
            "documentation": "The ODS code of the pharmacy. Used for releasing Nominated Pharmacy prescriptions",
            "type": "Identifier"
        },
        {
            "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": "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"
        }
    ]
}
<OperationDefinition xmlns="http://hl7.org/fhir">
    <id value="Task-release-message" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <url value="https://fhir.nhs.uk/OperationDefinition/Task-release-message" />
    <version value="4.0.1" />
    <name value="release-task" />
    <status value="draft" />
    <kind value="operation" />
    <date value="2020-11-13T09:29:23+11:00" />
    <publisher value="NHS Digital" />
    <contact>
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
        </telecom>
    </contact>
    <description value="TODO - Add description" />
    <code value="release" />
    <comment value="Only one of the parameters based-on.identifier and owner MUST be provided. This operation performs both a query on the message queue and updates the status of returned prescriptions." />
    <resource value="Task" />
    <system value="false" />
    <type value="true" />
    <instance value="false" />
    <parameter>
        <name value="group-identifier" />
        <use value="in" />
        <min value="0" />
        <max value="1" />
        <documentation value="The short-form-prescription-id (token) of the prescription. Used for releasing Patient prescriptions" />
        <type value="Identifier" />
    </parameter>
    <parameter>
        <name value="owner" />
        <use value="in" />
        <min value="0" />
        <max value="1" />
        <documentation value="The ODS code of the pharmacy. Used for releasing Nominated Pharmacy prescriptions" />
        <type value="Identifier" />
    </parameter>
    <parameter>
        <name value="status" />
        <use value="in" />
        <min value="1" />
        <max value="1" />
        <documentation value="Status from ValueSet http://hl7.org/fhir/valueset-task-status.html Use: accepted" />
        <type value="code" />
    </parameter>
    <parameter>
        <name value="return" />
        <use value="out" />
        <min value="1" />
        <max value="1" />
        <documentation value="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 value="Bundle" />
    </parameter>
</OperationDefinition>

group-identifier and owner

One of these values MUST be populated.

  • group-identifier is used to download a single prescription. This is called a Patient Release Request. This group identifier is either retrieved via the Task API Prescription Tracker API or is presented to the pharmacy to the pharmacy by the patient (on paper or patient App).
  • owner is used to download prescriptions where the pharmacy is the nominated pharmacy and have not been downloaded before. This is called a Nominated Pharmacy Release

Patient Release Request

        {
            "name": "group-identifier",
            "valueIdentifier": {
                "system": "https://fhir.nhs.uk/Id/prescription-order-number",
                "value": "82D996-C81010-11DB12"
            }
        },

Nominated Pharmacy Release Request

        {
            "name": "owner",
            "valueIdentifier": {
                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                "value": "VNE51"
            }
        }

accept

The only value to be used is accepted. This is for consistency with NHSDigital-Task and for future use.

        {
            "name": "status",
            "valueCode": "accepted"
        },

agent

This is the provenance behind the request and is NHSDigital-PractitionerRole resource. The resource should be populated using the guidance for this profile. Strict compliance to the profile is not enforced.

For attended request this should match CIS2 details being used. For unattended requests, a practitioner is still required, this should be a nominated member of the pharmacy and the data reflects their CIS2 identity.

The value of the telecom field should be the contact number a prescriber will use to contact the pharmacy.


PractitionerRole Patient Release Request (attended) Nominated Pharmacy Release Request (attended) Nominated Pharmacy Release Request (unattended)
identifier
practitioner (professional code)
organization (ODS code) ✓ (if different to owner) ✓ (if different to owner)
telecom
        {
            "name": "agent",
            "resource": {
                "resourceType": "PractitionerRole",
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
                        "value": "555086415105"
                    }
                ],
                "practitioner": {
                    "identifier": {
                        "system": "https://fhir.hl7.org.uk/Id/gmc-number",
                        "value": "C1231234"
                    },
                    "display": "Jackie Clark"
                },
                "organization": {
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                        "value": "RHM"
                    },
                    "display": "UNIVERSITY HOSPITAL SOUTHAMPTON NHS FOUNDATION TRUST"
                },
                "telecom":  [
                    {
                        "system": "phone",
                        "value": "02380798431",
                        "use": "work"
                    }
                ]
            }
        }

back to top